Struct FlowResult<T>

Namespace

SharpConsoleUI.Flows

Assembly

SharpConsoleUI.dll

Represents the outcome of a completed flow run, carrying either a typed value, a cancellation signal, or a fault with the originating exception.

public readonly struct FlowResult<T>

Type Parameters

T

The type of value produced by a successfully completed flow.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.BindTwoWay<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>, Func<TTgt, TSrc>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TValue>(TBuilder, TSource, Expression<Func<TSource, TValue>>, Expression<Func<TControl, TValue>>)

BindingExtensions.Bind<TBuilder, TControl, TSource, TSrc, TTgt>(TBuilder, TSource, Expression<Func<TSource, TSrc>>, Expression<Func<TControl, TTgt>>, Func<TSrc, TTgt>)

Properties

Cancelled

true when the flow was cancelled by the user or the host.

public bool Cancelled { get; }

Property Value

bool

Completed

true when the flow completed successfully and Value is valid.

public bool Completed { get; }

Property Value

bool

Error

The exception that caused the fault. Only meaningful when Faulted is true.

public Exception? Error { get; }

Property Value

Exception

Faulted

true when the flow terminated due to an unhandled exception.

public bool Faulted { get; }

Property Value

bool

Value

The value produced by the flow. Only meaningful when Completed is true.

public T? Value { get; }

Property Value

T

Methods

Cancel()

Creates a cancellation result indicating the flow was abandoned.

public static FlowResult<T> Cancel()

Returns

FlowResult<T>

A FlowResult<T> with Cancelled set to true.

Complete(T)

Creates a successful completion result carrying value.

public static FlowResult<T> Complete(T value)

Parameters

value T

The value produced by the flow.

Returns

FlowResult<T>

A FlowResult<T> with Completed set to true.

Fault(Exception)

Creates a fault result wrapping the given exception.

public static FlowResult<T> Fault(Exception error)

Parameters

error Exception

The exception that caused the flow to fault.

Returns

FlowResult<T>

A FlowResult<T> with Faulted set to true.