Struct BranchArgument

An argument to a branch.

Inherited Members

System.ValueType.Equals(System.Object)

System.ValueType.GetHashCode()

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetType()

Namespace: Flame.Compiler

Assembly: Flame.Compiler.dll

Syntax

public struct BranchArgument

Properties

IsTryException

Tests if this branch argument is the exception thrown by a 'try' flow's inner instruction.

Declaration

public bool IsTryException { get; }

Property Value

Type	Description
System.Boolean

IsTryResult

Tests if this branch argument is the result of a 'try' flow's inner instruction.

Declaration

public bool IsTryResult { get; }

Property Value

Type	Description
System.Boolean

IsValue

Tests if this branch argument is a value.

Declaration

public bool IsValue { get; }

Property Value

Type	Description
System.Boolean

Kind

Gets a description of this branch argument's kind.

Declaration

public BranchArgumentKind Kind { get; }

Property Value

Type	Description
BranchArgumentKind	The branch argument's kind.

TryException

Gets a branch argument that represents the exception thrown by a 'try' flow's inner instruction.

Declaration

public static BranchArgument TryException { get; }

Property Value

Type	Description
BranchArgument	A branch argument.

TryResult

Gets a branch argument that represents the result of a 'try' flow's inner instruction.

Declaration

public static BranchArgument TryResult { get; }

Property Value

Type	Description
BranchArgument	A branch argument.

ValueOrNull

Gets the value referred to by this branch argument. This is non-null if and only if this branch argument is a value.

Declaration

public ValueTag ValueOrNull { get; }

Property Value

Type	Description
ValueTag	The value referred to by this branch argument.

Methods

FromValue(ValueTag)

Creates a branch argument that passes a particular value to the branch's target block.

Declaration

public static BranchArgument FromValue(ValueTag value)

Parameters

Type	Name	Description
ValueTag	value	The value to pass to the target block.

Returns

Type	Description
BranchArgument	A branch argument.

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Overrides

System.ValueType.ToString()