Struct radicle_surf::file_system::Label

pub struct Label {
    pub label: String,
    // some fields omitted
}

A label for Directory and File to allow for search.

These are essentially directory and file names.

Examples

use radicle_surf::file_system::error as file_error;
use radicle_surf::file_system::{Label, Path};
use std::convert::TryFrom;

fn build_lib_path() -> Result<Path, file_error::Error> {
    let lib_filename = Label::try_from("lib.rs")?;
    let src_directory_name = Label::try_from("src")?;
    Ok(Path::from_labels(src_directory_name, &[lib_filename]))
}

Fields

label: String

Methods

impl Label

pub fn root() -> Self

The root label for the root directory, i.e. "~".

Prefer creating a root Path, by using Path::root.

Examples

use radicle_surf::file_system::{Label, Path};

let root = Path::root();
assert_eq!(*root.split_first().0, Label::root());

pub fn is_root(&self) -> bool

Trait Implementations

impl Clone for Label

fn clone(&self) -> Label

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Label

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

Formats the value using the given formatter.

impl Display for Label

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

Formats the value using the given formatter.

impl Eq for Label

impl FromStr for Label

type Err = Error

The associated error which can be returned from parsing.

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

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

impl Hash for Label

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 Ord for Label

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

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

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

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

This method tests for !=.

impl PartialOrd<Label> for Label

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for Label

impl StructuralPartialEq for Label

impl<'_> TryFrom<&'_ str> for Label

type Error = Error

The type returned in the event of a conversion error.

fn try_from(item: &str) -> Result<Self, Self::Error>

Performs the conversion.