[−][src]Struct gflags::Flag
The state associated with a single flag.
An invocation of gflags::define!
with flag long name --the_name
and
flag type T
declares an item static the_name: Flag<T>
through which the
state of the flag can be accessed.
After gflags::parse()
has been called, the value of a flag is available
through its .flag
field which is of type T
.
Examples
use std::path::Path; gflags::define! { /// Search for patterns from the given file, with one pattern per line. -f, --file: &Path } fn main() { let patterns = gflags::parse(); if FILE.is_present() { let path = FILE.flag; println!("searching for patterns from file: {}", path.display()); } else { println!("searching for patterns given on command line: {:?}", patterns); } }
Methods
impl<T: 'static> Flag<T>
[src]
pub fn is_present(&self) -> bool
[src]
Whether this flag was provided on the command line.
When using flags for which a default value is not provided, be sure to
check .is_present()
because accessing .flag
when not present will
cause a panic.
When a flag has a default value and is not passed on the command line,
is_present()
will be false and .flag
will refer to the default
value.
Trait Implementations
Auto Trait Implementations
impl<T> Sync for Flag<T>
impl<T> Unpin for Flag<T> where
T: Unpin,
T: Unpin,
impl<T> Send for Flag<T>
impl<T> RefUnwindSafe for Flag<T>
impl<T> UnwindSafe for Flag<T> where
T: RefUnwindSafe,
T: RefUnwindSafe,
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,