Class CliTaskHandler

Namespace

NanoByte.Common.Tasks

Assembly

NanoByte.Common.dll

Informs the user about the progress of tasks and ask questions using console output.

[MustDisposeResource]
public class CliTaskHandler : TaskHandlerBase, ITaskHandler

Inheritance

object

TaskHandlerBase

CliTaskHandler

Implements

ITaskHandler

Derived

AnsiCliTaskHandler

Inherited Members

TaskHandlerBase.LogHandler(LogSeverity, string, Exception)

TaskHandlerBase.CancellationTokenSource

TaskHandlerBase.CancellationToken

TaskHandlerBase.Verbosity

TaskHandlerBase.Ask(string, bool?, string)

TaskHandlerBase.Output<T>(string, IEnumerable<T>)

TaskHandlerBase.Output<T>(string, NamedCollection<T>)

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)

TaskHandlerExtensions.OutputLow(ITaskHandler, string, string)

TaskHandlerExtensions.OutputLow<T>(ITaskHandler, string, NamedCollection<T>)

TaskHandlerExtensions.OutputLow<T>(ITaskHandler, string, IEnumerable<T>)

TaskHandlerExtensions.RunTaskAndReturn<T>(ITaskHandler, ResultTask<T>)

JsonStorage.ReparseAsJson<T>(object)

JsonStorage.ReparseAsJson<T>(object, T)

XmlStorage.SaveXml(object, Stream, string?)

XmlStorage.ToXmlString(object, string?)

Remarks

This class is thread-safe.

Constructors

CliTaskHandler()

Creates a new CLI task handler. Registers a Handler and a System.Console.CancelKeyPress handler.

public CliTaskHandler()

Properties

CredentialProvider

Used to ask the user or a keyring for System.Net.NetworkCredentials for specific System.Uris; can be null.

protected override ICredentialProvider CredentialProvider { get; }

Property Value

ICredentialProvider

IsInteractive

Indicates whether the user can provide input.

protected override bool IsInteractive { get; }

Property Value

bool

Methods

AskInteractive(string, bool)

Asks the user a Yes/No/Cancel question.

protected override bool AskInteractive(string question, bool defaultAnswer)

Parameters

question string

The question and comprehensive information to help the user make an informed decision.

defaultAnswer bool

The default answer to preselect.

Returns

bool

true if the user answered with 'Yes'; false if the user answered with 'No'.

Exceptions

OperationCanceledException

Throw if the user answered with 'Cancel'.

DisplayLogEntry(LogSeverity, string)

Prints Log entries to the System.Console.

protected override void DisplayLogEntry(LogSeverity severity, string message)

Parameters

severity LogSeverity

message string

Dispose()

Unregisters the Handler and the System.Console.CancelKeyPress handler.

public override void Dispose()

Error(Exception)

Displays an error message to the user.

public override void Error(Exception exception)

Parameters

exception Exception

The exception representing the error that occurred.

GetLogColor(LogSeverity)

Determines the color to use for a log entry based on the LogSeverity.

protected static ConsoleColor GetLogColor(LogSeverity severity)

Parameters

severity LogSeverity

Returns

ConsoleColor

Output(string, string)

Displays multi-line text to the user.

public override void Output(string title, string message)

Parameters

title string

A title for the message.

message string

The string to display. Trailing linebreaks are appropriately handled or ignored.

Remarks

Implementations may close the UI as a side effect. Therefore this should be your last call on the handler.

RunTask(ITask)

Runs an ITask and tracks its progress. Returns once the task has been completed.

public override void RunTask(ITask task)

Parameters

task ITask

The task to be run. (Run(CancellationToken, ICredentialProvider?, IProgress<TaskSnapshot>?) or equivalent is called on it.)

Exceptions

OperationCanceledException

The user canceled the task.

IOException

The task ended with IOError.

WebException

The task ended with WebError.