Struct ConfigMinTwoUsize 

pub struct ConfigMinTwoUsize(/* private fields */);

A usize configuration value that rejects 0 and 1 when set from strings.

Use this for options whose consumer divides the value in half to size an internal buffer (e.g. a bounded channel capacity): values below 2 would round down to a zero-capacity buffer and panic. Invalid values return a configuration error through ConfigField instead.

Implementations

impl ConfigMinTwoUsize

pub fn try_new(value: usize) -> Result<Self>

Creates a ConfigMinTwoUsize, returning a configuration error if value is less than 2.

pub const fn get(self) -> usize

Returns the wrapped usize.

Trait Implementations

impl Clone for ConfigMinTwoUsize

fn clone(&self) -> ConfigMinTwoUsize

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ConfigField for ConfigMinTwoUsize

fn visit<V: Visit>(&self, v: &mut V, key: &str, description: &'static str)

fn set(&mut self, key: &str, value: &str) -> Result<()>

fn reset(&mut self, key: &str) -> Result<()>

impl Copy for ConfigMinTwoUsize

impl Debug for ConfigMinTwoUsize

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

Formats the value using the given formatter.

impl Display for ConfigMinTwoUsize

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

Formats the value using the given formatter.

impl Eq for ConfigMinTwoUsize

impl From<ConfigMinTwoUsize> for usize

fn from(value: ConfigMinTwoUsize) -> Self

Converts to this type from the input type.

impl FromStr for ConfigMinTwoUsize

type Err = DataFusionError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ConfigMinTwoUsize

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

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

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ConfigMinTwoUsize

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