Struct PathFinderConfig 

pub struct PathFinderConfig {
    pub max_depth: usize,
    pub max_paths: usize,
}

The PathFinderConfig object provides a standard interface for configuring various implemented transformers.

Fields

max_depth: usize

Maximum search depth for pathfinding

max_paths: usize

Maximum number of paths to find

Implementations

impl PathFinderConfig

pub const DEFAULT_MAX_DEPTH: usize = 5

the default maximum search depth for pathfinding

pub const DEFAULT_MAX_PATHS: usize = 5

the default maximum number of paths to find

pub const fn new(depth: usize, paths: usize) -> PathFinderConfig

returns a new instance of the PathFinderConfig with the given values

pub const fn from_depth(depth: usize) -> PathFinderConfig

returns a new instance of the PathFinderConfig with the given depth and default paths

pub const fn from_paths(paths: usize) -> PathFinderConfig

returns a new instance of the PathFinderConfig with the given paths and default depth

pub const fn max_depth(&self) -> usize

returns the maximum depth for pathfinding

pub const fn max_depth_mut(&mut self) -> &mut usize

returns a mutable reference to the maximum depth for pathfinding

pub const fn max_paths(&self) -> usize

returns the maximum number of paths to find

pub const fn max_paths_mut(&mut self) -> &mut usize

returns a mutable reference to the maximum number of paths to find

pub const fn replace_max_depth(&mut self, depth: usize) -> usize

replace the maximum depth for pathfinding, returning the previous value

pub const fn replace_max_paths(&mut self, paths: usize) -> usize

replace the maximum number of paths to find, returning the previous value

pub const fn replace(&mut self, other: PathFinderConfig) -> PathFinderConfig

replace the current values with that of another instance

pub const fn set_max_depth(&mut self, depth: usize)

set the maximum depth for pathfinding

pub const fn set_max_paths(&mut self, paths: usize)

set the maximum number of paths to find

pub fn with_max_depth(self, depth: usize) -> PathFinderConfig

consumes the current instance to create another with the given maximum depth

pub fn with_max_paths(self, paths: usize) -> PathFinderConfig

consumes the current instance to create another with the given maximum number of paths

Trait Implementations

impl Clone for PathFinderConfig

fn clone(&self) -> PathFinderConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathFinderConfig

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

Formats the value using the given formatter.

impl Default for PathFinderConfig

fn default() -> PathFinderConfig

Returns the “default value” for a type.

impl Display for PathFinderConfig

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

Formats the value using the given formatter.

impl Hash for PathFinderConfig

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

where __H: Hasher,

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 Ord for PathFinderConfig

fn cmp(&self, other: &PathFinderConfig) -> 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 PathFinderConfig

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

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

impl Eq for PathFinderConfig

impl StructuralPartialEq for PathFinderConfig