Struct structdoc::Flags

pub struct Flags { /* fields omitted */ }

Flags on nodes of Documentation.

Can be put onto a documentation node with Documentation::set_flag.

Methods

impl Flags

pub const FLATTEN: Flags

Flatten structure into a parent.

For structure field inside a structure, this skips the one level and puts all the inner fields directly inside the outer struct.

For enums inside structs, this suggests that the fields are merged inline the outer struct, but still keeps the separation inside the documentation.

pub const HIDE: Flags

This part of documentation should be hidden.

pub const OPTIONAL: Flags

The presence of this field is optional.

This may be caused either by it to reasonably contain a no-value (eg. Option<T>, Vec<T>) or by having a default value. Any possible default value should be described in the doc comment.

pub const fn empty() -> Flags

Returns an empty set of flags

pub const fn all() -> Flags

Returns the set containing all flags.

pub const fn bits(&self) -> u8

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u8) -> Option<Flags>

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

pub const fn from_bits_truncate(bits: u8) -> Flags

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

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: Flags) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Eq for Flags

impl Extend<Flags> for Flags

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

Extends a collection with the contents of an iterator.

impl Clone for Flags

fn clone(&self) -> Flags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Flags> for Flags

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

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

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

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

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

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

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

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

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

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

impl Ord for Flags

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

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

Restrict a value to a certain interval.

impl PartialEq<Flags> for Flags

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

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

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

This method tests for !=.

impl Copy for Flags

impl Hash for Flags

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 Sub<Flags> for Flags

type Output = Flags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<Flags> for Flags

fn sub_assign(&mut self, other: Flags)

Disables all flags enabled in the set.

impl Not for Flags

type Output = Flags

The resulting type after applying the ! operator.

fn not(self) -> Flags

Returns the complement of this set of flags.

impl BitAnd<Flags> for Flags

type Output = Flags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<Flags> for Flags

type Output = Flags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<Flags> for Flags

type Output = Flags

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<Flags> for Flags

fn bitand_assign(&mut self, other: Flags)

Disables all flags disabled in the set.

impl BitOrAssign<Flags> for Flags

fn bitor_assign(&mut self, other: Flags)

Adds the set of flags.

impl BitXorAssign<Flags> for Flags

fn bitxor_assign(&mut self, other: Flags)

Toggles the set of flags.

impl Debug for Flags

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

Formats the value using the given formatter.

impl FromIterator<Flags> for Flags

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

Creates a value from an iterator.

impl Octal for Flags

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

Formats the value using the given formatter.

impl Binary for Flags

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

Formats the value using the given formatter.

impl LowerHex for Flags

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

Formats the value using the given formatter.

impl UpperHex for Flags

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

Formats the value using the given formatter.