Enum SelectionOrder 

pub enum SelectionOrder {
    Inherit,
    Original,
    Random,
    Shuffled,
    Sorted,
    Probabilistic,
}

Variants

Inherit

Original

Random

Shuffled

Sorted

Probabilistic

Implementations

impl SelectionOrder

pub fn resolve(self, inherited: SelectionOrder) -> SelectionOrder

Resolves the selection order by inheriting from a parent if necessary.

Arguments

• inherited - The selection order to inherit from if this is Inherit

Returns

The resolved selection order (never Inherit)

pub fn is_random(&self) -> bool

Returns true if this selection order implies random selection.

This is used to determine whether a selector should use random iteration or deterministic iteration.

pub fn requires_caching(&self) -> bool

Returns true if this selection order requires caching.

Some selection orders need to collect all elements before iteration can begin (e.g., Shuffled, Sorted, Probabilistic).

pub fn from_random_selection(random: bool) -> Self

Converts from a boolean random selection flag.

Arguments

• random - true for Random, false for Original

pub fn to_random_selection(&self) -> bool

Converts to a boolean random selection flag.

Panics

Panics if this is not Random or Original.

Trait Implementations

impl Clone for SelectionOrder

fn clone(&self) -> SelectionOrder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SelectionOrder

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

Formats the value using the given formatter.

impl Default for SelectionOrder

fn default() -> SelectionOrder

Returns the “default value” for a type.

impl Hash for SelectionOrder

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for SelectionOrder

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

impl Eq for SelectionOrder

impl StructuralPartialEq for SelectionOrder