Class AnsiCliProgressContext

Namespace

NanoByte.Common.Tasks

Assembly

NanoByte.Common.AnsiCli.dll

Container for one or more ANSI console progress bars.

[MustDisposeResource]
public sealed class AnsiCliProgressContext

Inheritance

object

AnsiCliProgressContext

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

AnsiCliProgressContext()

Starts a progress context.

public AnsiCliProgressContext()

Properties

IsFinished

Indicates whether all tasks have completed.

public bool IsFinished { get; }

Property Value

bool

Methods

Add(string)

Adds a new progress bar to the context.

public IProgress<TaskSnapshot> Add(string description)

Parameters

description string

A descriptive text to show next to the progress bar.

Returns

IProgress<TaskSnapshot>

A handle for updating the state of the progress bar.

Dispose()

Ends the progress context.

public void Dispose()