Struct TransportReadinessResult

Namespace

AnyProtocol.Protocol.Abstraction

Assembly

AnyProtocol.Protocol.Abstraction.dll

Contains the outcome of transport readiness processing.

public readonly struct TransportReadinessResult : IEquatable<TransportReadinessResult>

Implements

IEquatable<TransportReadinessResult>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

TransportReadinessResult(TransportReadinessState, string?)

Contains the outcome of transport readiness processing.

public TransportReadinessResult(TransportReadinessState State, string? Description = null)

Parameters

State TransportReadinessState

The state.

Description string

An optional human-readable description.

Properties

Description

An optional human-readable description.

public string? Description { get; init; }

Property Value

string

State

The state.

public TransportReadinessState State { get; init; }

Property Value

TransportReadinessState

Methods

Deconstruct(out TransportReadinessState, out string?)

public void Deconstruct(out TransportReadinessState State, out string? Description)

Parameters

State TransportReadinessState

Description string

Equals(TransportReadinessResult)

public bool Equals(TransportReadinessResult other)

Parameters

other TransportReadinessResult

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

NotReady(string?)

Creates a readiness result indicating that the transport is not ready.

public static TransportReadinessResult NotReady(string? description = null)

Parameters

description string

An optional human-readable description.

Returns

TransportReadinessResult

A not-ready transport result with the optional description.

Ready(string?)

Creates a readiness result indicating that the transport is ready.

public static TransportReadinessResult Ready(string? description = null)

Parameters

description string

An optional human-readable description.

Returns

TransportReadinessResult

A ready transport result with the optional description.

ToString()

public override string ToString()

Returns

string

Unknown(string?)

Creates a readiness result whose state has not yet been determined.

public static TransportReadinessResult Unknown(string? description = null)

Parameters

description string

An optional human-readable description.

Returns

TransportReadinessResult

An unknown transport result with the optional description.

Operators

operator ==(TransportReadinessResult, TransportReadinessResult)

public static bool operator ==(TransportReadinessResult left, TransportReadinessResult right)

Parameters

left TransportReadinessResult

right TransportReadinessResult

Returns

bool

operator !=(TransportReadinessResult, TransportReadinessResult)

public static bool operator !=(TransportReadinessResult left, TransportReadinessResult right)

Parameters

left TransportReadinessResult

right TransportReadinessResult

Returns

bool