Class StreamHelper
Namespace: FastReport.Olap.Export.BIFF8
Assembly: FastCube.Mono.dll
Provides API to binary stream
public class StreamHelper : Stream
Inheritance
object ← MarshalByRefObject ← Stream ← StreamHelper
Constructors
StreamHelper(bool)
Creates a new instance.
public StreamHelper(bool useFile = false)
Parameters
useFile bool
Properties
CanRead
When overridden in a derived class, gets a value indicating whether the current stream supports reading.
public override bool CanRead { get; }
Property Value
CanSeek
When overridden in a derived class, gets a value indicating whether the current stream supports seeking.
public override bool CanSeek { get; }
Property Value
CanWrite
When overridden in a derived class, gets a value indicating whether the current stream supports writing.
public override bool CanWrite { get; }
Property Value
Length
When overridden in a derived class, gets the length in bytes of the stream.
public override long Length { get; }
Property Value
Exceptions
A class derived from Stream does not support seeking.
Methods were called after the stream was closed.
Position
When overridden in a derived class, gets or sets the position within the current stream.
public override long Position { get; set; }
Property Value
Exceptions
An I/O error occurs.
The stream does not support seeking.
Methods were called after the stream was closed.
Methods
Dispose(bool)
Releases the unmanaged resources used by the System.IO.Stream and optionally releases the managed resources.
protected override void Dispose(bool disposing)
Parameters
disposing bool
true to release both managed and unmanaged resources; false to release only unmanaged resources.
Flush()
When overridden in a derived class, clears all buffers for this stream and causes any buffered data to be written to the underlying device.
public override void Flush()
Exceptions
An I/O error occurs.
Read(byte[], int, int)
When overridden in a derived class, reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read.
public override int Read(byte[] buffer, int offset, int count)
Parameters
buffer byte[]
An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source.
offset int
The zero-based byte offset in buffer at which to begin storing the data read from the current stream.
count int
The maximum number of bytes to be read from the current stream.
Returns
The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached.
Exceptions
The sum of offset and count is larger than the buffer length.
buffer is null.
offset or count is negative.
An I/O error occurs.
The stream does not support reading.
Methods were called after the stream was closed.
ReadByte()
Reads a byte from the stream and advances the position within the stream by one byte, or returns -1 if at the end of the stream.
public override int ReadByte()
Returns
The unsigned byte cast to an Int32, or -1 if at the end of the stream.
Exceptions
The stream does not support reading.
Methods were called after the stream was closed.
Seek(long, SeekOrigin)
When overridden in a derived class, sets the position within the current stream.
public override long Seek(long offset, SeekOrigin origin)
Parameters
offset long
A byte offset relative to the origin parameter.
origin SeekOrigin
A value of type System.IO.SeekOrigin indicating the reference point used to obtain the new position.
Returns
The new position within the current stream.
Exceptions
An I/O error occurs.
The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
Methods were called after the stream was closed.
SetLength(long)
When overridden in a derived class, sets the length of the current stream.
public override void SetLength(long value)
Parameters
value long
The desired length of the current stream in bytes.
Exceptions
An I/O error occurs.
The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
Methods were called after the stream was closed.
Write(byte[], int, int)
When overridden in a derived class, writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written.
public override void Write(byte[] buffer, int offset, int count)
Parameters
buffer byte[]
An array of bytes. This method copies count bytes from buffer to the current stream.
offset int
The zero-based byte offset in buffer at which to begin copying bytes to the current stream.
count int
The number of bytes to be written to the current stream.
Exceptions
The sum of offset and count is greater than the buffer length.
buffer is null.
offset or count is negative.
An I/O error occured, such as the specified file cannot be found.
The stream does not support writing.
System.IO.Stream.Write(System.Byte[],System.Int32,System.Int32) was called after the stream was closed.
WriteByte(byte)
Writes a byte to the current position in the stream and advances the position within the stream by one byte.
public override void WriteByte(byte value)
Parameters
value byte
The byte to write to the stream.
Exceptions
An I/O error occurs.
The stream does not support writing, or the stream is already closed.
Methods were called after the stream was closed.