Enum BfsError 

pub enum BfsError {
    StartElementNotContained,
    VisitedTooSmall {
        needed: usize,
        actual: usize,
    },
    QueueTooSmall {
        needed: usize,
        actual: usize,
    },
    StartIndexOutOfBounds {
        index: usize,
        bound: usize,
    },
    NeighborIndexOutOfBounds {
        index: usize,
        bound: usize,
    },
}

Error returned when caller-provided BFS scratch cannot support traversal.

Performance

perf: unspecified; errors are returned only before traversal starts.

Variants

StartElementNotContained

The start element is not valid and visible in the topology view.

VisitedTooSmall

The visited scratch slice is smaller than graph.element_bound().

Fields

needed: usize

Required visited entries.

actual: usize

Provided visited entries.

QueueTooSmall

The queue scratch slice is smaller than graph.element_bound().

Fields

needed: usize

Required queue entries.

actual: usize

Provided queue entries.

StartIndexOutOfBounds

The start element maps outside graph.element_bound().

Fields

index: usize

Dense index returned for the start element.

bound: usize

Exclusive element index bound for the topology view.

NeighborIndexOutOfBounds

Traversal observed a successor or predecessor element whose dense index is at or past graph.element_bound(). Indicates the topology view violated its ElementSuccessors or ElementPredecessors contract: an expanded element ID must map below the element bound that was in effect when traversal started.

Fields

index: usize

Dense index returned for the offending element.

bound: usize

Exclusive element index bound that was in effect for this traversal.

Trait Implementations

impl Clone for BfsError

fn clone(&self) -> BfsError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for BfsError

impl Debug for BfsError

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

Formats the value using the given formatter.

impl Display for BfsError

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

Formats the value using the given formatter.

impl Eq for BfsError

impl Error for BfsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl PartialEq for BfsError

fn eq(&self, other: &BfsError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for BfsError