Struct TokenSymbolHandle

Namespace

Farkle.Grammars

Assembly

Farkle.dll

Points to a TokenSymbol of a Grammar.

public readonly struct TokenSymbolHandle : IEquatable<TokenSymbolHandle>

Implements

IEquatable<TokenSymbolHandle>

Inherited Members

ValueType.ToString()

Remarks

This type is lightweight, storing just a number without a Grammar object and can be of use when parsing. To get any information about the token symbol you have to pass it to the GetTokenSymbol(TokenSymbolHandle) method.

Properties

HasValue

Whether this TokenSymbolHandle has a valid value.

public bool HasValue { get; }

Property Value

bool

See Also

Value

Value

Gets the token symbol's index in the grammar.

public int Value { get; }

Property Value

int

Remarks

The first token symbol has a value of zero.

Exceptions

InvalidOperationException

The token symbol's HasValue property is false.

See Also

HasValue

Methods

Equals(TokenSymbolHandle)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(TokenSymbolHandle other)

Parameters

other TokenSymbolHandle

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

Operators

operator ==(TokenSymbolHandle, TokenSymbolHandle)

Checks if two TokenSymbolHandles are pointing to the same row.

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

Parameters

left TokenSymbolHandle

The first handle.

right TokenSymbolHandle

The second handle.

Returns

bool

Remarks

If left and right come from different Grammars the result is undefined.

explicit operator TokenSymbolHandle(EntityHandle)

Casts an EntityHandle to a TokenSymbolHandle.

public static explicit operator TokenSymbolHandle(EntityHandle handle)

Parameters

handle EntityHandle

The EntityHandle to cast.

Returns

TokenSymbolHandle

Exceptions

InvalidCastException

handle's IsTokenSymbol property is false.

implicit operator EntityHandle(TokenSymbolHandle)

Implicitly converts a TokenSymbolHandle to an EntityHandle.

public static implicit operator EntityHandle(TokenSymbolHandle handle)

Parameters

handle TokenSymbolHandle

The TokenSymbolHandle to convert.

Returns

EntityHandle

operator !=(TokenSymbolHandle, TokenSymbolHandle)

Checks if two TokenSymbolHandles are not pointing to the same row.

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

Parameters

left TokenSymbolHandle

The first handle.

right TokenSymbolHandle

The second handle.

Returns

bool

Remarks

If left and right come from different Grammars the result is undefined.