Struct realpath_ext::RealpathFlags

pub struct RealpathFlags { /* fields omitted */ }

Flags that modify path resolution.

These flags were modeled after the options to the GNU realpath program.

Implementations

impl RealpathFlags

pub const ALLOW_MISSING: RealpathFlags

Allow any component of the given path to be missing, inaccessible, or not a directory when it should be.

pub const ALLOW_LAST_MISSING: RealpathFlags

Allow the last component of the given path to be missing.

pub const IGNORE_SYMLINKS: RealpathFlags

Do not resolve symbolic links as they are encountered.

Note that if this option is passed, the returned path may not refer to the correct file! Certain combinations of .. and/or symbolic links can cause this.

pub const fn empty() -> RealpathFlags

Returns an empty set of flags

pub const fn all() -> RealpathFlags

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<RealpathFlags>

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) -> RealpathFlags

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

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

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

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

Trait Implementations

impl Binary for RealpathFlags

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

Formats the value using the given formatter.

impl BitAnd<RealpathFlags> for RealpathFlags

type Output = RealpathFlags

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitAndAssign<RealpathFlags> for RealpathFlags

fn bitand_assign(&mut self, other: RealpathFlags)

Disables all flags disabled in the set.

impl BitOr<RealpathFlags> for RealpathFlags

type Output = RealpathFlags

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitOrAssign<RealpathFlags> for RealpathFlags

fn bitor_assign(&mut self, other: RealpathFlags)

Adds the set of flags.

impl BitXor<RealpathFlags> for RealpathFlags

type Output = RealpathFlags

The resulting type after applying the ^ operator.

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

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

impl BitXorAssign<RealpathFlags> for RealpathFlags

fn bitxor_assign(&mut self, other: RealpathFlags)

Toggles the set of flags.

impl Clone for RealpathFlags

fn clone(&self) -> RealpathFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for RealpathFlags

impl Debug for RealpathFlags

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

Formats the value using the given formatter.

impl Eq for RealpathFlags

impl Extend<RealpathFlags> for RealpathFlags

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

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub 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<RealpathFlags> for RealpathFlags

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

Creates a value from an iterator.

impl Hash for RealpathFlags

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub 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 RealpathFlags

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

Formats the value using the given formatter.

impl Not for RealpathFlags

type Output = RealpathFlags

The resulting type after applying the ! operator.

fn not(self) -> RealpathFlags

Returns the complement of this set of flags.

impl Octal for RealpathFlags

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

Formats the value using the given formatter.

impl Ord for RealpathFlags

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<RealpathFlags> for RealpathFlags

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

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

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

This method tests for !=.

impl PartialOrd<RealpathFlags> for RealpathFlags

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 StructuralEq for RealpathFlags

impl StructuralPartialEq for RealpathFlags

impl Sub<RealpathFlags> for RealpathFlags

type Output = RealpathFlags

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl SubAssign<RealpathFlags> for RealpathFlags

fn sub_assign(&mut self, other: RealpathFlags)

Disables all flags enabled in the set.

impl UpperHex for RealpathFlags

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

Formats the value using the given formatter.