Struct TraversalIntent

Namespace

Trailblazer.Pathing

Assembly

Trailblazer.dll

Defines the exact starting medium and allowed target media for a path query.

public readonly struct TraversalIntent : IEquatable<TraversalIntent>

Implements

IEquatable<TraversalIntent>

Inherited Members

ValueType.ToString()

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

TraversalIntent(TraversalMedium, TraversalMedia)

Creates immutable traversal intent.

public TraversalIntent(TraversalMedium startMedium, TraversalMedia targetMedia)

Parameters

startMedium TraversalMedium

targetMedia TraversalMedia

Exceptions

ArgumentException

Thrown when target media are empty or contain an unknown bit.

ArgumentOutOfRangeException

Thrown when the start medium is unknown.

Properties

StartMedium

Gets the exact traversal medium at the query start.

public TraversalMedium StartMedium { get; }

Property Value

TraversalMedium

TargetMedia

Gets the nonempty set of known traversal media allowed at the target.

public TraversalMedia TargetMedia { get; }

Property Value

TraversalMedia

Methods

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

Equals(TraversalIntent)

public bool Equals(TraversalIntent other)

Parameters

other TraversalIntent

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

Operators

operator ==(TraversalIntent, TraversalIntent)

Returns whether two traversal intents have exactly equal values.

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

Parameters

left TraversalIntent

right TraversalIntent

Returns

bool

operator !=(TraversalIntent, TraversalIntent)

Returns whether two traversal intents differ.

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

Parameters

left TraversalIntent

right TraversalIntent

Returns

bool