Struct btlib::BlockPathRef

pub struct BlockPathRef<'a>(_);

A reference to a block path.

BlockPathRef is to BlockPath as std::path::Path is to std::path::PathBuf.

Implementations

impl<'a> BlockPathRef<'a>

pub fn new(path: &'a str) -> StdResult<BlockPathRef<'_>, BlockPathError>

Creates a new BlockPathRef which references the path described by path.

Methods from Deref<Target = BlockPathGen<&'a str>>

pub fn contains<U: AsRef<str>>(&self, other: &BlockPathGen<U>) -> bool

Returns true if other is a subpath of this path.

pub fn root(&self) -> &Principal

Returns a reference to the root of this path.

pub fn components(&self) -> Components<'_>

Returns an iterator over the components in this path.

pub fn relative_to<'a, U: AsRef<str>>( &'a self, rel_to: &BlockPathGen<U> ) -> Result<RelBlockPath<'a>>

Calculates the RelBlockPath representing this path relative to rel_to.

pub fn port(&self) -> Result<u16>

Returns the port to use if this path is used as the bind path of a process.

Trait Implementations

impl<'a> Clone for BlockPathRef<'a>

fn clone(&self) -> BlockPathRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BlockPathRef<'a>

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

Formats the value using the given formatter.

impl<'a> Default for BlockPathRef<'a>

fn default() -> BlockPathRef<'a>

Returns the “default value” for a type.

impl<'a> Deref for BlockPathRef<'a>

type Target = BlockPathGen<&'a str>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for BlockPathRef<'de>

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

Deserialize this value from the given Serde deserializer.

impl<'a> Display for BlockPathRef<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for BlockPathRef<'a>

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<'a> Ord for BlockPathRef<'a>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<'a> PartialEq<BlockPathRef<'a>> for BlockPathRef<'a>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, T: AsRef<str>> PartialEq<T> for BlockPathRef<'a>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> PartialOrd<BlockPathRef<'a>> for BlockPathRef<'a>

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

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

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

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

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

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

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<'a> Serialize for BlockPathRef<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> TryFrom<&'a str> for BlockPathRef<'a>

type Error = BlockPathError

The type returned in the event of a conversion error.

fn try_from(string: &'a str) -> StdResult<BlockPathRef<'_>, BlockPathError>

Performs the conversion.

impl<'a> Eq for BlockPathRef<'a>