ZLibStream Class

Definition

Namespace:

System.IO.Compression

Assembly:

System.IO.Compression.dll

Source:

ZLibStream.cs

Provides methods and properties used to compress and decompress streams by using the zlib data format specification.

public ref class ZLibStream sealed : System::IO::Stream

public sealed class ZLibStream : System.IO.Stream

type ZLibStream = class
    inherit Stream

Public NotInheritable Class ZLibStream
Inherits Stream

Inheritance

Object

MarshalByRefObject

Stream

ZLibStream

Constructors

ZLibStream(Stream, CompressionLevel, Boolean)	Initializes a new instance of the ZLibStream class by using the specified stream, compression level, and whether to leave the stream open.
ZLibStream(Stream, CompressionLevel)	Initializes a new instance of the ZLibStream class by using the specified stream and compression level.
ZLibStream(Stream, CompressionMode, Boolean)	Initializes a new instance of the ZLibStream class by using the specified stream, compression mode, and whether to leave the stream open.
ZLibStream(Stream, CompressionMode)	Initializes a new instance of the ZLibStream class by using the specified stream and compression mode.
ZLibStream(Stream, ZLibCompressionOptions, Boolean)	Initializes a new instance of the ZLibStream class by using the specified stream and compression options, and optionally leaves the stream open.

Properties

BaseStream	Gets a reference to the underlying stream.
CanRead	Gets a value indicating whether the stream supports reading.
CanSeek	Gets a value indicating whether the stream supports seeking.
CanTimeout	Gets a value that determines whether the current stream can time out. (Inherited from Stream)
CanWrite	Gets a value indicating whether the stream supports writing.
Length	This property is not supported and always throws a NotSupportedException.
Position	This property is not supported and always throws a NotSupportedException.
ReadTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to read before timing out. (Inherited from Stream)
WriteTimeout	Gets or sets a value, in milliseconds, that determines how long the stream will attempt to write before timing out. (Inherited from Stream)

Methods

BeginRead(Byte[], Int32, Int32, AsyncCallback, Object)	Begins an asynchronous read operation.
BeginWrite(Byte[], Int32, Int32, AsyncCallback, Object)	Begins an asynchronous write operation.
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, Int32)	Reads the bytes from the current stream and writes them to another stream, using the specified buffer size.
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)
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.
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)	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)
CreateObjRef(Type)	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)	Releases the unmanaged resources used by the Stream and optionally releases the managed resources. (Inherited from Stream)
DisposeAsync()	Asynchronously releases all resources used by the stream.
EndRead(IAsyncResult)	Waits for the pending asynchronous read to complete.
EndWrite(IAsyncResult)	Ends an asynchronous write operation.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
Flush()	Flushes the internal buffers.
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 clears all buffers for this stream, causes any buffered data to be written to the underlying device, and monitors cancellation requests.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetLifetimeService()	Obsolete. 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()	Obsolete. 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)	Reads a number of decompressed bytes into the specified byte array.
Read(Span<Byte>)	Reads a number of decompressed bytes into the specified byte span.
ReadAsync(Byte[], Int32, Int32, 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.
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(Memory<Byte>, 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.
ReadAtLeast(Span<Byte>, Int32, Boolean)	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(Memory<Byte>, Int32, Boolean, CancellationToken)	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.
ReadExactly(Byte[], Int32, Int32)	Reads count number of bytes from the current stream and advances the position within the stream. (Inherited from Stream)
ReadExactly(Span<Byte>)	Reads bytes from the current stream and advances the position within the stream until the buffer is filled. (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)
ReadExactlyAsync(Memory<Byte>, 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)
Seek(Int64, SeekOrigin)	This method is not supported and always throws a NotSupportedException.
SetLength(Int64)	This method is not supported and always throws a NotSupportedException.
ToString()	Returns a string that represents the current object. (Inherited from Object)
Write(Byte[], Int32, Int32)	Writes compressed bytes to the underlying stream from the specified byte array.
Write(ReadOnlySpan<Byte>)	Writes compressed bytes to the underlying stream from the specified byte span.
WriteAsync(Byte[], Int32, Int32, 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.
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(ReadOnlyMemory<Byte>, 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.
WriteByte(Byte)	Writes a byte to the current position in the stream and advances the position within the stream by one byte.

Extension Methods

CopyToAsync(Stream, PipeWriter, CancellationToken)	Asynchronously reads the bytes from the Stream and writes them to the specified PipeWriter, using a cancellation token.
ConfigureAwait(IAsyncDisposable, Boolean)	Configures how awaits on the tasks returned from an async disposable will be performed.