Skip to main content

FlagValue

Enum FlagValue 

Source
pub enum FlagValue {
    String(String),
    Bool(bool),
    Int(i64),
    Float(f64),
    StringSlice(Vec<String>),
}
Expand description

Represents the value of a parsed flag

FlagValue is an enum that can hold different types of values that flags can have. This allows for type-safe access to flag values.

§Examples

use flag_rs::flag::{FlagValue, FlagType, Flag};

// Parse different types of values
let string_flag = Flag::new("name").value_type(FlagType::String);
let value = string_flag.parse_value("John").unwrap();
assert_eq!(value.as_string().unwrap(), "John");

let bool_flag = Flag::new("verbose").value_type(FlagType::Bool);
let value = bool_flag.parse_value("true").unwrap();
assert!(value.as_bool().unwrap());

Variants§

§

String(String)

A string value

§

Bool(bool)

A boolean value

§

Int(i64)

An integer value

§

Float(f64)

A floating-point value

§

StringSlice(Vec<String>)

A slice of strings (for repeated flags)

Implementations§

Source§

impl FlagValue

Source

pub fn as_string(&self) -> Result<&String>

Returns the value as a string reference

§Errors

Returns Error::FlagParsing if the value is not a string

§Examples
use flag_rs::flag::FlagValue;

let value = FlagValue::String("hello".to_string());
assert_eq!(value.as_string().unwrap(), "hello");

let value = FlagValue::Bool(true);
assert!(value.as_string().is_err());
Source

pub fn as_bool(&self) -> Result<bool>

Returns the value as a boolean

§Errors

Returns Error::FlagParsing if the value is not a boolean

Source

pub fn as_int(&self) -> Result<i64>

Returns the value as an integer

§Errors

Returns Error::FlagParsing if the value is not an integer

Source

pub fn as_float(&self) -> Result<f64>

Returns the value as a float

§Errors

Returns Error::FlagParsing if the value is not a float

Source

pub fn as_string_slice(&self) -> Result<&Vec<String>>

Returns the value as a string slice reference

§Errors

Returns Error::FlagParsing if the value is not a string slice

Trait Implementations§

Source§

impl Clone for FlagValue

Source§

fn clone(&self) -> FlagValue

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for FlagValue

Source§

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

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

impl PartialEq for FlagValue

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 StructuralPartialEq for FlagValue

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.