Struct glib::OptionFlags

pub struct OptionFlags { /* fields omitted */ }

Flags which modify individual options.

Implementations

impl OptionFlags

pub const NONE: OptionFlags

No flags. Since: 2.42.

pub const HIDDEN: OptionFlags

The option doesn’t appear in --help output.

pub const IN_MAIN: OptionFlags

The option appears in the main section of the --help output, even if it is defined in a group.

pub const REVERSE: OptionFlags

For options of the OptionArg::None kind, this flag indicates that the sense of the option is reversed.

pub const NO_ARG: OptionFlags

For options of the OptionArg::Callback kind, this flag indicates that the callback does not take any argument (like a OptionArg::None option). Since 2.8

pub const FILENAME: OptionFlags

For options of the OptionArg::Callback kind, this flag indicates that the argument should be passed to the callback in the GLib filename encoding rather than UTF-8. Since 2.8

pub const OPTIONAL_ARG: OptionFlags

For options of the OptionArg::Callback kind, this flag indicates that the argument supply is optional. If no argument is given then data of GOptionParseFunc will be set to NULL. Since 2.8

pub const NOALIAS: OptionFlags

This flag turns off the automatic conflict resolution which prefixes long option names with groupname- if there is a conflict. This option should only be used in situations where aliasing is necessary to model some legacy commandline interface. It is not safe to use this option, unless all option groups are under your direct control. Since 2.8.

pub const fn empty() -> OptionFlags

Returns an empty set of flags

pub const fn all() -> OptionFlags

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<OptionFlags>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> OptionFlags

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> OptionFlags

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: OptionFlags) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: OptionFlags) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: OptionFlags)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: OptionFlags)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: OptionFlags)

Toggles the specified flags in-place.

pub fn set(&mut self, other: OptionFlags, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for OptionFlags

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

Formats the value using the given formatter.

impl BitAnd<OptionFlags> for OptionFlags

fn bitand(self, other: OptionFlags) -> OptionFlags

Returns the intersection between the two sets of flags.

type Output = OptionFlags

The resulting type after applying the & operator.

impl BitAndAssign<OptionFlags> for OptionFlags

fn bitand_assign(&mut self, other: OptionFlags)

Disables all flags disabled in the set.

impl BitOr<OptionFlags> for OptionFlags

fn bitor(self, other: OptionFlags) -> OptionFlags

Returns the union of the two sets of flags.

type Output = OptionFlags

The resulting type after applying the | operator.

impl BitOrAssign<OptionFlags> for OptionFlags

fn bitor_assign(&mut self, other: OptionFlags)

Adds the set of flags.

impl BitXor<OptionFlags> for OptionFlags

fn bitxor(self, other: OptionFlags) -> OptionFlags

Returns the left flags, but with all the right flags toggled.

type Output = OptionFlags

The resulting type after applying the ^ operator.

impl BitXorAssign<OptionFlags> for OptionFlags

fn bitxor_assign(&mut self, other: OptionFlags)

Toggles the set of flags.

impl Clone for OptionFlags

fn clone(&self) -> OptionFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OptionFlags

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

Formats the value using the given formatter.

impl Display for OptionFlags

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

Formats the value using the given formatter.

impl Extend<OptionFlags> for OptionFlags

fn extend<T: IntoIterator<Item = OptionFlags>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<OptionFlags> for OptionFlags

fn from_iter<T: IntoIterator<Item = OptionFlags>>(iterator: T) -> OptionFlags

Creates a value from an iterator.

impl Hash for OptionFlags

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, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for OptionFlags

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

Formats the value using the given formatter.

impl Not for OptionFlags

fn not(self) -> OptionFlags

Returns the complement of this set of flags.

type Output = OptionFlags

The resulting type after applying the ! operator.

impl Octal for OptionFlags

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

Formats the value using the given formatter.

impl Ord for OptionFlags

fn cmp(&self, other: &OptionFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<OptionFlags> for OptionFlags

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<OptionFlags> for OptionFlags

fn partial_cmp(&self, other: &OptionFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Sub<OptionFlags> for OptionFlags

fn sub(self, other: OptionFlags) -> OptionFlags

Returns the set difference of the two sets of flags.

type Output = OptionFlags

The resulting type after applying the - operator.

impl SubAssign<OptionFlags> for OptionFlags

fn sub_assign(&mut self, other: OptionFlags)

Disables all flags enabled in the set.

impl UpperHex for OptionFlags

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

Formats the value using the given formatter.

impl Copy for OptionFlags

impl Eq for OptionFlags

impl StructuralEq for OptionFlags

impl StructuralPartialEq for OptionFlags