YEncReader Class

A streaming reader for single-part and multipart yEnc blocks.

Definition

Namespace: MimeKit.Encodings
Assembly: MimeKit.Core (in MimeKit.Core.dll) Version: 5.0.0
C#
public sealed class YEncReader : IDisposable
Inheritance
Object    YEncReader
Implements
IDisposable

Remarks

Call ReadNext(CancellationToken) and then DecodeTo(Stream, CancellationToken) for each block. To discard a block while still validating it, decode to Null.

This reader does not assemble multipart files, interpret MIME, or undo NNTP dot-stuffing. Supply the article body after transport decoding. Do not access the underlying stream while reading: the reader buffers input beyond the current block.

Content written to the destination is provisional until decoding completes successfully. A failed operation invalidates the reader. Instances are not thread-safe.

Constructors

YEncReader Initialize a yEnc reader.

Properties

Checksum Get the computed, finalized CRC32 of the decoded block.
DecodedSize Get the number of decoded bytes in the current block.
ExpectedChecksum Get the whole-file checksum advertised by the trailer.
ExpectedPartChecksum Get the part checksum advertised by the trailer.
Header Get the current block's header.

Methods

DecodeTo Decode and validate the current block.
DecodeToAsync Asynchronously decode and validate the current block.
Dispose Dispose the reader.
Equals Determines whether the specified object is equal to the current object.
(Inherited from Object)
GetHashCode Serves as the default hash function.
(Inherited from Object)
GetType Gets the Type of the current instance.
(Inherited from Object)
ReadNext Read the next yEnc header.
ReadNextAsync Asynchronously read the next yEnc header.
ToString Returns a string that represents the current object.
(Inherited from Object)

See Also