Skip to main content

BooleanConversionOptions

Struct BooleanConversionOptions 

Source
pub struct BooleanConversionOptions {
    pub case_sensitive: bool,
    /* private fields */
}
Expand description

Options that control string-to-boolean conversion.

Fields§

§case_sensitive: bool

Whether literal matching is case-sensitive.

Implementations§

Source§

impl BooleanConversionOptions

Source

pub fn strict() -> Self

Creates strict boolean conversion options.

§Returns

Options accepting true, false, 1, and 0.

Source

pub fn env_friendly() -> Self

Creates options suitable for environment variable values.

§Returns

Options accepting true/false, 1/0, yes/no, and on/off.

Source

pub fn true_literals(&self) -> &[String]

Gets the accepted true literals.

§Returns

A slice of accepted true literals.

Source

pub fn false_literals(&self) -> &[String]

Gets the accepted false literals.

§Returns

A slice of accepted false literals.

Source

pub fn with_case_sensitive(self, case_sensitive: bool) -> Self

Returns a copy with boolean literal matching case sensitivity changed.

§Parameters
  • case_sensitive - Whether matching is case-sensitive.
§Returns

Updated options.

Source

pub fn with_true_literal(self, literal: &str) -> Self

Returns a copy that accepts an additional true literal.

§Parameters
  • literal - Literal to parse as true.
§Returns

Updated options.

Source

pub fn with_false_literal(self, literal: &str) -> Self

Returns a copy that accepts an additional false literal.

§Parameters
  • literal - Literal to parse as false.
§Returns

Updated options.

Source

pub fn parse(&self, value: &str) -> Option<bool>

Parses a boolean literal using these options.

§Parameters
  • value - Candidate boolean literal.
§Returns

Returns Some(bool) when the literal is recognized, or None otherwise.

Trait Implementations§

Source§

impl Clone for BooleanConversionOptions

Source§

fn clone(&self) -> BooleanConversionOptions

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BooleanConversionOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BooleanConversionOptions

Source§

fn default() -> Self

Creates default boolean conversion options.

Source§

impl PartialEq for BooleanConversionOptions

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Eq for BooleanConversionOptions

Source§

impl StructuralPartialEq for BooleanConversionOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.