Nerdbank.Streams

Specialized .NET Stream classes

Enhanced streams for communication in-proc or across the Internet.

Features

1. SimplexStream is meant to allow two parties to communicate one direction. Anything written to the stream can subsequently be read from it. You can share this Stream with any two parties (in the same AppDomain) and one can send messages to the other.
2. FullDuplexStream creates a pair of bidirectional streams for in-proc two-way communication; it also creates a single bidirectional stream from two unidirectional streams.
3. MultiplexingStream allows you to split any bidirectional .NET Stream into many sub-streams (called channels). This allows two parties to establish just one transport stream (e.g. named pipe or web socket) and use it for many independent protocols. For example, one might set up JSON-RPC on one channel and use other channels for efficient binary transfers.
4. AsStream() wraps a WebSocket, System.IO.Pipelines.PipeReader, System.IO.Pipelines.PipeWriter, or System.IO.Pipelines.IDuplexPipe with a System.IO.Stream for reading and/or writing.
5. UsePipe() enables reading from and writing to a Stream or WebSocket using the PipeReader and PipeWriter APIs.
6. Stream.ReadSlice(long) creates a sub-stream that ends after a given number of bytes.
7. PipeReader.ReadSlice(long) creates a sub-PipeReader that ends after a given number of bytes.
8. MonitoringStream wraps another Stream and raises events for all I/O calls so you can monitor and/or trace the data as it goes by.
9. WriteSubstream and ReadSubstream allow you to serialize data of an unknown length as part of a larger stream, and later deserialize it such in reading the substream, you cannot read more bytes than were written to it.
10. Sequence<T> is a builder for ReadOnlySequence<T>.
11. PrefixingBufferWriter<T> wraps another IBufferWriter<T> to allow for prefixing some header to the next written buffer, which may be arbitrarily long.
12. BufferTextWriter is a TextWriter-derived type that can write directly to any IBufferWriter<byte>, making it more reusable than StreamWriter and thus allows for alloc-free writing across many writers.
13. SequenceTextReader is a TextReader-derived type that can read directly from any ReadOnlySequence<byte>, making it more reusable than StreamReader and thus allows for alloc-free reading across many sequences.
14. DuplexPipe is a trivial implementation of IDuplexPipe.
15. Stream.ReadBlockAsync guarantees to fill the supplied buffer except under certain documented conditions, instead of the regular ReadAsync guarantee of supplying at least 1 byte.