 | Filtered |
A stream which filters data as it is read or written.
Inheritance HierarchyNamespace: MimeKit.IO
Assembly: MimeKit (in MimeKit.dll) Version: 4.0.0
SyntaxC#
public class FilteredStream : Stream, ICancellableStream
The FilteredStream type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | FilteredStream | Initialize a new instance of the FilteredStream class. |
Properties| Name | Description | |
|---|---|---|
 | CanRead |
Check whether or not the stream supports reading.
(Overrides StreamCanRead) |
| CanSeek |
Check whether or not the stream supports seeking.
(Overrides StreamCanSeek) |
| CanTimeout |
Check whether or not I/O operations can timeout.
(Overrides StreamCanTimeout) |
| CanWrite |
Check whether or not the stream supports writing.
(Overrides StreamCanWrite) |
| Length |
Get the length of the stream, in bytes.
(Overrides StreamLength) |
| Position |
Get or set the current position within the stream.
(Overrides StreamPosition) |
| ReadTimeout |
Get or set a value, in milliseconds, that determines how long the stream will attempt to read before timing out.
(Overrides StreamReadTimeout) |
| Source | Get the underlying source stream. |
| WriteTimeout |
Get or set a value, in milliseconds, that determines how long the stream will attempt to write before timing out.
(Overrides StreamWriteTimeout) |
Methods| Name | Description | |
|---|---|---|
| Add | Add a filter. |
| 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) |
| Contains | Check if the filtered stream contains the specified filter. |
| CopyTo(Stream) | Reads the bytes from the current stream and writes them to another stream. (Inherited from Stream) |
| CopyTo(Stream, Int32) | Reads the bytes from the current stream and writes them to another stream, using a specified buffer size. (Inherited from Stream) |
| CopyToAsync(Stream) | Asynchronously reads the bytes from the current stream and writes them to another stream. (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. (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. (Inherited from Stream) |
| CreateObjRef | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject) |
 | CreateWaitHandle | Obsolete. 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 FilteredStream and
optionally releases the managed resources.
(Overrides StreamDispose(Boolean)) |
| 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) |
| Flush(CancellationToken) | Clear all buffers for this stream and causes any buffered data to be written to the underlying device. |
| 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 | Obsolete. Provides support for a Contract. (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)) |
| Read(Byte, Int32, Int32, CancellationToken) | Read a sequence of bytes from the stream and advances the position within the stream by the number of bytes read. |
| 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)) |
| 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) |
| Remove | Remove a filter. |
| 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(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)) |
| Write(Byte, Int32, Int32, CancellationToken) | Write a sequence of bytes to the stream and advances the current position within this stream by the number of bytes written. |
| 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) |
Remarks
Passes data through each IMimeFilter as the data is read or written.
See Also