Class ReadStream

Namespace

NanoByte.Common.Streams

Assembly

NanoByte.Common.dll

Reads the contents of a stream.

public class ReadStream : TaskBase, ITask

Inheritance

object

MarshalByRefObject

TaskBase

ReadStream

Implements

ITask

Inherited Members

TaskBase.Tag

TaskBase.CanCancel

TaskBase.PreventIdle

TaskBase.CancellationToken

TaskBase.CredentialProvider

TaskBase.Run(CancellationToken, ICredentialProvider, IProgress<TaskSnapshot>)

TaskBase.State

TaskBase.UnitsProcessed

TaskBase.UnitsTotal

Extension Methods

BinaryStorage.SaveBinary<T>(T, Stream)

BinaryStorage.SaveBinary<T>(T, string)

JsonStorage.SaveJson<T>(T, Stream)

JsonStorage.SaveJson<T>(T, string)

JsonStorage.ToJsonString<T>(T)

XmlStorage.SaveXml<T>(T, string, string?)

UpdateUtils.To<TIn, TOut>(TIn, Func<TIn, TOut>)

ConversionUtils.ConvertToString<TType>(TType)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

XmlStorage.SaveXml(object, Stream, string?)

XmlStorage.ToXmlString(object, string?)

Constructors

ReadStream(string, Stream, Action<Stream>)

Reads the contents of a stream.

public ReadStream(string name, Stream stream, Action<Stream> callback)

Parameters

name string

A name describing the task in human-readable form.

stream Stream

The stream to read.

callback Action<Stream>

Called with a ProgressStream wrapped around the stream.

Properties

Name

A name describing the task in human-readable form.

public override string Name { get; }

Property Value

string

UnitsByte

true if UnitsProcessed and UnitsTotal are measured in bytes; false if they are measured in generic units.

protected override bool UnitsByte { get; }

Property Value

bool

Methods

Execute()

The actual code to be executed.

protected override void Execute()

Remarks

State is automatically set to Started before calling this method, to Complete after a successful exit and to an appropriate error state in case on an exception. You can set additional TaskStates during execution.

Exceptions

OperationCanceledException

The operation was canceled.

IOException

The task ended with IOError.

WebException

The task ended with WebError.