Class FixedLengthStream

Implements a specialized stream that wraps another stream that does not support seeking such that the Length property will return a specific value.

This is useful for situations such as a web request handler that needs to process the body stream which does not implement Length but where this length is required.

To use, simply construct an instance, passing the source stream and its length (often obtained via an HTTP Content-Length header.

note

This stream is really intended just for reading data and does not support:

writing
seeking
setting the length

Inheritance

object

MarshalByRefObject

Stream

FixedLengthStream

Namespace: Neon.IO

Assembly: Neon.Common.dll

Syntax

public class FixedLengthStream : Stream

Constructors

FixedLengthStream(Stream, long)

Constructor.

Declaration

public FixedLengthStream(Stream stream, long length)

Parameters

Type	Name	Description
Stream	stream	The source stream.
long	length	The stream length.

Properties

CanRead

When overridden in a derived class, gets a value indicating whether the current stream supports reading.

Declaration

public override bool CanRead { get; }

Property Value

Type	Description
bool	true if the stream supports reading; otherwise, false.

Overrides

Stream.CanRead

CanSeek

When overridden in a derived class, gets a value indicating whether the current stream supports seeking.

Declaration

public override bool CanSeek { get; }

Property Value

Type	Description
bool	true if the stream supports seeking; otherwise, false.

Overrides

Stream.CanSeek

CanWrite

When overridden in a derived class, gets a value indicating whether the current stream supports writing.

Declaration

public override bool CanWrite { get; }

Property Value

Type	Description
bool	true if the stream supports writing; otherwise, false.

Overrides

Stream.CanWrite

Length

Returns the fixed stream length passed to the constructor.

Declaration

public override long Length { get; }

Property Value

Type	Description
long

Overrides

Stream.Length

Position

When overridden in a derived class, gets or sets the position within the current stream.

Declaration

public override long Position { get; set; }

Property Value

Type	Description
long	The current position within the stream.

Overrides

Stream.Position

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support seeking.
ObjectDisposedException	Methods were called after the stream was closed.

Methods

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.

Declaration

public override void Flush()

Overrides

Stream.Flush()

Exceptions

Type	Condition
IOException	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.

Declaration

public override int Read(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer	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.
int	offset	The zero-based byte offset in `buffer` at which to begin storing the data read from the current stream.
int	count	The maximum number of bytes to be read from the current stream.

Returns

Type	Description
int	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 `count` is 0 or the end of the stream has been reached.

Overrides

Stream.Read(byte[], int, int)

Exceptions

Type	Condition
ArgumentException	The sum of `offset` and `count` is larger than the buffer length.
ArgumentNullException	`buffer` is null.
ArgumentOutOfRangeException	`offset` or `count` is negative.
IOException	An I/O error occurs.
NotSupportedException	The stream does not support reading.
ObjectDisposedException	Methods were called after the stream was closed.

Seek(long, SeekOrigin)

When overridden in a derived class, sets the position within the current stream.

Declaration

public override long Seek(long offset, SeekOrigin origin)

Parameters

Type	Name	Description
long	offset	A byte offset relative to the `origin` parameter.
SeekOrigin	origin	A value of type SeekOrigin indicating the reference point used to obtain the new position.

Returns

Type	Description
long	The new position within the current stream.

Overrides

Stream.Seek(long, SeekOrigin)

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException	Methods were called after the stream was closed.

SetLength(long)

When overridden in a derived class, sets the length of the current stream.

Declaration

public override void SetLength(long value)

Parameters

Type	Name	Description
long	value	The desired length of the current stream in bytes.

Overrides

Stream.SetLength(long)

Exceptions

Type	Condition
IOException	An I/O error occurs.
NotSupportedException	The stream does not support both writing and seeking, such as if the stream is constructed from a pipe or console output.
ObjectDisposedException	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.

Declaration

public override void Write(byte[] buffer, int offset, int count)

Parameters

Type	Name	Description
byte[]	buffer	An array of bytes. This method copies `count` bytes from `buffer` to the current stream.
int	offset	The zero-based byte offset in `buffer` at which to begin copying bytes to the current stream.
int	count	The number of bytes to be written to the current stream.

Overrides

Stream.Write(byte[], int, int)

Exceptions

Type	Condition
ArgumentException	The sum of `offset` and `count` is greater than the buffer length.
ArgumentNullException	`buffer` is null.
ArgumentOutOfRangeException	`offset` or `count` is negative.
IOException	An I/O error occurred, such as the specified file cannot be found.
NotSupportedException	The stream does not support writing.
ObjectDisposedException	Write(byte[], int, int) was called after the stream was closed.

Extension Methods

IOExtensions.DeflateTo(Stream, Stream)

IOExtensions.GunzipTo(Stream, Stream)

IOExtensions.GzipTo(Stream, Stream)

IOExtensions.InflateTo(Stream, Stream)

IOExtensions.ReadBytes(Stream, int)

IOExtensions.ReadToEnd(Stream)

IOExtensions.ReadToEndAsync(Stream)

IOExtensions.Write(Stream, byte[])

IOExtensions.WriteAsync(Stream, byte[])