Bounded Stream Class
A bounded stream, confined to reading and writing data to a limited subset of the overall source stream.
Definition
Namespace: MimeKit.IO
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public class BoundedStream : Stream- Inheritance
- Object MarshalByRefObject Stream BoundedStream
Remarks
Wraps an arbitrary stream, limiting I/O operations to a subset of the source stream. If the EndBoundary is -1, then the end of the stream is unbound.
When a IMimeParser is set to parse a persistent stream, it will construct MimeContents using bounded streams instead of loading the content into memory.
Constructors
| BoundedStream | Initialize a new instance of the BoundedStream class. |
Properties
| BaseStream | Get the underlying stream. |
| CanRead |
Check whether the stream supports reading.
(Overrides StreamCanRead) |
| CanSeek |
Check whether the stream supports seeking.
(Overrides StreamCanSeek) |
| CanTimeout |
Check whether I/O operations can time out.
(Overrides StreamCanTimeout) |
| CanWrite |
Check whether the stream supports writing.
(Overrides StreamCanWrite) |
| EndBoundary | Get the end boundary offset of the underlying stream. |
| LeaveOpen | Check whether the underlying stream will remain open after the BoundedStream is disposed. |
| Length |
Get the length of the stream, in bytes.
(Overrides StreamLength) |
| Position |
Get or sets the current position within the stream.
(Overrides StreamPosition) |
| ReadTimeout |
Get or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
(Overrides StreamReadTimeout) |
| StartBoundary | Get the start boundary offset of the underlying stream. |
| WriteTimeout |
Get or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
(Overrides StreamWriteTimeout) |
Methods
| BeginRead | Begins an asynchronous read operation. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| BeginWrite | Begins an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| Close | Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. Instead of calling this method, ensure that the stream is properly disposed. (Inherited from Stream) |
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyTo(Stream, Int32) | Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyToAsync(Stream) | Asynchronously reads the bytes from the current stream and writes them to another stream. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyToAsync(Stream, Int32) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyToAsync(Stream, CancellationToken) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified cancellation token. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CopyToAsync(Stream, Int32, CancellationToken) | Asynchronously reads the bytes from the current stream and writes them to another stream, using a specified buffer size and cancellation token. Both streams positions are advanced by the number of bytes copied. (Inherited from Stream) |
| CreateWaitHandle | Allocates a WaitHandle object. (Inherited from Stream) |
| Dispose | Releases all resources used by the Stream. (Inherited from Stream) |
| Dispose(Boolean) |
Release the unmanaged resources used by the BoundedStream and
optionally releases the managed resources.
(Overrides StreamDispose(Boolean)) |
| DisposeAsync | Asynchronously releases the unmanaged resources used by the Stream. (Inherited from Stream) |
| EndRead | Waits for the pending asynchronous read to complete. (Consider using ReadAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| EndWrite | Ends an asynchronous write operation. (Consider using WriteAsync(Byte, Int32, Int32) instead.) (Inherited from Stream) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| Flush |
Clear all buffers for this stream and causes any buffered data to be written
to the underlying device.
(Overrides StreamFlush) |
| FlushAsync | Asynchronously clears all buffers for this stream and causes any buffered data to be written to the underlying device. (Inherited from Stream) |
| FlushAsync(CancellationToken) |
Asynchronously clear all buffers for this stream and causes any buffered data to be written
to the underlying device.
(Overrides StreamFlushAsync(CancellationToken)) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService | Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService | Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) | Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| ObjectInvariant | Provides support for a Contract. (Inherited from Stream) |
| Read(SpanByte) | 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. (Inherited from Stream) |
| Read(Byte, Int32, Int32) |
Read a sequence of bytes from the stream and advances the position
within the stream by the number of bytes read.
(Overrides StreamRead(Byte, Int32, Int32)) |
| ReadAsync(MemoryByte, CancellationToken) | Asynchronously reads a sequence of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream) |
| ReadAsync(Byte, Int32, Int32) | Asynchronously reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream) |
| ReadAsync(Byte, Int32, Int32, CancellationToken) |
Asynchronously read a sequence of bytes from the stream and advances the position
within the stream by the number of bytes read.
(Overrides StreamReadAsync(Byte, Int32, Int32, CancellationToken)) |
| ReadAtLeast | Reads at least a minimum number of bytes from the current stream and advances the position within the stream by the number of bytes read. (Inherited from Stream) |
| ReadAtLeastAsync | Asynchronously reads at least a minimum number of bytes from the current stream, advances the position within the stream by the number of bytes read, and monitors cancellation requests. (Inherited from Stream) |
| 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. (Inherited from Stream) |
| ReadExactly(SpanByte) | Reads bytes from the current stream and advances the position within the stream until the buffer is filled. (Inherited from Stream) |
| ReadExactly(Byte, Int32, Int32) | Reads count number of bytes from the current stream and advances the position within the stream. (Inherited from Stream) |
| ReadExactlyAsync(MemoryByte, CancellationToken) | Asynchronously reads bytes from the current stream, advances the position within the stream until the buffer is filled, and monitors cancellation requests. (Inherited from Stream) |
| ReadExactlyAsync(Byte, Int32, Int32, CancellationToken) | Asynchronously reads count number of bytes from the current stream, advances the position within the stream, and monitors cancellation requests. (Inherited from Stream) |
| Seek |
Set the position within the current stream.
(Overrides StreamSeek(Int64, SeekOrigin)) |
| SetLength |
Set the length of the stream.
(Overrides StreamSetLength(Int64)) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Write(ReadOnlySpanByte) | 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. (Inherited from Stream) |
| Write(Byte, Int32, Int32) |
Write a sequence of bytes to the stream and advances the current
position within this stream by the number of bytes written.
(Overrides StreamWrite(Byte, Int32, Int32)) |
| WriteAsync(ReadOnlyMemoryByte, CancellationToken) | Asynchronously writes a sequence of bytes to the current stream, advances the current position within this stream by the number of bytes written, and monitors cancellation requests. (Inherited from Stream) |
| WriteAsync(Byte, Int32, Int32) | Asynchronously writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. (Inherited from Stream) |
| WriteAsync(Byte, Int32, Int32, CancellationToken) |
Asynchronously write a sequence of bytes to the stream and advances the current
position within this stream by the number of bytes written.
(Overrides StreamWriteAsync(Byte, Int32, Int32, CancellationToken)) |
| WriteByte | Writes a byte to the current position in the stream and advances the position within the stream by one byte. (Inherited from Stream) |