Enum TraversalPosition

pub enum TraversalPosition {
    Start,
    Name(String),
    Index(u64),
    End,
}

Seek position inside a directory. The precise meaning of the Name and Index values are entirely up to an implementation; it could indicate the next entry to be returned or the last entry returned; the type should be considered to be opaque to the client. There are some implementations that return entries in alphabetical order, but they are not required to do so. The Start value indicates the first entry should be returned and the End value indicates no more entries should be returned.

Variants

Start

The first entry in the directory.

Name(String)

A name of an entry.

Index(u64)

The index of an entry.

End

The whole listing was traversed. There is nothing else to return.

Trait Implementations

impl Clone for TraversalPosition

fn clone(&self) -> TraversalPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TraversalPosition

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

Formats the value using the given formatter.

impl Default for TraversalPosition

The default value specifies a traversal that is positioned on the very first entry.

fn default() -> Self

Returns the “default value” for a type.

impl Ord for TraversalPosition

fn cmp(&self, other: &TraversalPosition) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for TraversalPosition

fn eq(&self, other: &TraversalPosition) -> 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 PartialOrd for TraversalPosition

fn partial_cmp(&self, other: &TraversalPosition) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for TraversalPosition

impl StructuralPartialEq for TraversalPosition