Struct PathSelector 

pub struct PathSelector { /* private fields */ }

A platform-independent description of a filesystem scope.

Implementations

impl PathSelector

pub fn absolute(path: impl Into<PathBuf>) -> Result<Self, PolicyError>

Creates an absolute selector without touching the filesystem.

pub fn workspace_root() -> Self

Creates a selector for the workspace root itself.

pub const fn root() -> Self

Creates a selector for every system root supplied by the runtime.

The selector is symbolic. A backend must populate PathResolutionContext::with_root for the target platform.

pub fn workspace(relative: impl Into<PathBuf>) -> Result<Self, PolicyError>

Creates a selector relative to every workspace root.

pub const fn minimal() -> Self

Creates the platform-minimal runtime scope.

pub const fn tmpdir() -> Self

Creates the platform temporary-directory scope.

pub const fn slash_tmp() -> Self

Creates the conventional /tmp scope.

pub fn resolve(&self, context: &PathResolutionContext) -> Vec<PathBuf>

Resolves this selector against a caller-provided runtime context.

pub fn path(&self) -> Option<&Path>

Returns the stored path for an absolute or workspace-relative selector.

pub const fn is_special(&self) -> bool

Returns whether this selector is a special platform-defined scope.

pub const fn is_workspace_scope(&self) -> bool

Returns whether this selector resolves relative to runtime workspace roots.

pub const fn is_root_scope(&self) -> bool

Returns whether this selector targets caller-supplied system roots.

pub const fn is_minimal_scope(&self) -> bool

Returns whether this selector targets the platform-minimal scope.

pub const fn is_tmpdir_scope(&self) -> bool

Returns whether this selector targets the platform temporary directory.

pub const fn is_slash_tmp_scope(&self) -> bool

Returns whether this selector targets the conventional /tmp scope.

pub const fn is_absolute_scope(&self) -> bool

Returns whether this selector stores a native absolute path.

Trait Implementations

impl Clone for PathSelector

fn clone(&self) -> PathSelector

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathSelector

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

Formats the value using the given formatter.

impl Eq for PathSelector

impl Hash for PathSelector

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for PathSelector

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for PathSelector

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for PathSelector

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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