 | Bound |
A bounded stream, confined to reading and writing data to a limited subset of the overall source stream.
Inheritance HierarchyNamespace: MimeKit.IO
Assembly: MimeKit (in MimeKit.dll) Version: 4.10.0
SyntaxC#
public class BoundStream : Stream
The BoundStream type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | BoundStream | Initialize a new instance of the BoundStream class. |
Properties| Name | Description | |
|---|---|---|
 | 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 BoundStream 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| Name | Description | |
|---|---|---|
| BeginRead | (Inherited from Stream) |
| BeginWrite | (Inherited from Stream) |
| Close | (Inherited from Stream) |
| CopyTo(Stream) | (Inherited from Stream) |
| CopyTo(Stream, Int32) | (Inherited from Stream) |
| CopyToAsync(Stream) | (Inherited from Stream) |
| CopyToAsync(Stream, Int32) | (Inherited from Stream) |
| CopyToAsync(Stream, Int32, CancellationToken) | (Inherited from Stream) |
| CreateObjRef | (Inherited from MarshalByRefObject) |
 | CreateWaitHandle | Obsolete. (Inherited from Stream) |
| Dispose | (Inherited from Stream) |
| Dispose(Boolean) |
Release the unmanaged resources used by the BoundStream and
optionally releases the managed resources.
(Overrides StreamDispose(Boolean)) |
| EndRead | (Inherited from Stream) |
| EndWrite | (Inherited from Stream) |
| Equals | (Inherited from Object) |
| Finalize | (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 | (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 | (Inherited from Object) |
| GetLifetimeService | (Inherited from MarshalByRefObject) |
| GetType | (Inherited from Object) |
| InitializeLifetimeService | (Inherited from MarshalByRefObject) |
| MemberwiseClone | (Inherited from Object) |
| MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject) |
| ObjectInvariant | Obsolete. (Inherited from Stream) |
| Read |
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(Byte, Int32, Int32) | (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)) |
| ReadByte | (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 | (Inherited from Object) |
| Write |
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(Byte, Int32, Int32) | (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 | (Inherited from Stream) |
RemarksWraps 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 MimeParser is set to parse a persistent stream, it will construct MimeContents using bounded streams instead of loading the content into memory.
See Also