Struct pathfix::config::PathFlags

pub struct PathFlags { /* fields omitted */ }

Flags for a Path

PathFlags describes the requirements that the system must fulfill so that the Path will be included to the $PATH string.

Examples

Parse the PathFlags and check the current system.

use pathfix::config::{PathFlags, IncludeAdministrative};

let flags: PathFlags = "admin".parse().unwrap();
assert!(flags.check(PathFlags::this_system(&IncludeAdministrative::Always)));

Implementations

impl PathFlags

pub fn new() -> PathFlags

Creates empty PathFlags without any requirements.

Examples

use pathfix::config::PathFlags;

println!("{}", PathFlags::new());

pub fn check(self, given: PathFlags) -> bool

Checks if the PathFlags are given for the flags of the given system.

Example

Check if default flags are met.

use pathfix::config::{PathFlags, IncludeAdministrative};
assert!(
    PathFlags::new().check(
        PathFlags::this_system(&IncludeAdministrative::Always)
    )
);

pub fn this_system<I>(include_administrative: &I) -> PathFlags where
    I: Borrow<IncludeAdministrative>, 

Get given PathFlags for this system.

Example

Test if current system is Linux.

use pathfix::config::{PathFlags, IncludeAdministrative};

let requirements: PathFlags = "linux".parse().unwrap();
let this_system = PathFlags::this_system(&IncludeAdministrative::Always);

assert_eq!(requirements.check(this_system), cfg!(target_os = "linux"));

Trait Implementations

impl Clone for PathFlags

fn clone(&self) -> PathFlags

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PathFlags

impl Debug for PathFlags

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

Formats the value using the given formatter.

impl Default for PathFlags

fn default() -> PathFlags

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for PathFlags

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for PathFlags

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

Formats the value using the given formatter.

impl Eq for PathFlags

impl FromStr for PathFlags

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for PathFlags

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

This method returns an [Ordering] between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

#[must_use]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<PathFlags> for PathFlags

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

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

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

This method tests for !=.

impl PartialOrd<PathFlags> for PathFlags

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

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

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

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

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

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

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

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

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

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

impl Serialize for PathFlags

fn serialize<S>(
    &self,
    serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for PathFlags

impl StructuralPartialEq for PathFlags