Enum RoutingStep

pub enum RoutingStep {
    Forward(RoutingFrame),
    Choice(Choice),
}

A RoutingStep represents a unit of progress in the routing process.

Emitted by RoutingFrame::next_steps, each step describes how routing should proceed from a given frame:

• RoutingStep::Forward represents a deterministic hop to the next coordinate in the mesh, with an updated RoutingFrame.

• RoutingStep::Choice indicates that routing cannot proceed until the caller selects one of several admissible indices. This allows for policy-driven or non-deterministic routing behavior, such as load balancing.

Variants

Forward(RoutingFrame)

A deterministic routing hop to the next coordinate. Carries an updated RoutingFrame describing the new position and residual selection.

Choice(Choice)

A deferred routing decision at the current dimension. Contains a set of admissible indices and a residual RoutingFrame to continue routing once a choice is made.

Implementations

impl RoutingStep

pub fn is_forward(&self) -> bool

Returns true if this is a RoutingStep::Forward, otherwise false

pub fn as_forward_mut(&mut self) -> Option<&mut RoutingFrame>

Optionally returns mutable references to the inner fields if this is a RoutingStep::Forward, otherwise None

pub fn as_forward(&self) -> Option<&RoutingFrame>

Optionally returns references to the inner fields if this is a RoutingStep::Forward, otherwise None

pub fn into_forward(self) -> Result<RoutingFrame, Self>

Returns the inner fields if this is a RoutingStep::Forward, otherwise returns back the enum in the Err case of the result

pub fn is_choice(&self) -> bool

Returns true if this is a RoutingStep::Choice, otherwise false

pub fn as_choice_mut(&mut self) -> Option<&mut Choice>

Optionally returns mutable references to the inner fields if this is a RoutingStep::Choice, otherwise None

pub fn as_choice(&self) -> Option<&Choice>

Optionally returns references to the inner fields if this is a RoutingStep::Choice, otherwise None

pub fn into_choice(self) -> Result<Choice, Self>

Returns the inner fields if this is a RoutingStep::Choice, otherwise returns back the enum in the Err case of the result

Trait Implementations

impl Clone for RoutingStep

fn clone(&self) -> RoutingStep

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RoutingStep

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.