Struct btlib::BlockPathGen

pub struct BlockPathGen<T> { /* private fields */ }

A generic block path.

This type serves to unify the functionality of BlockPath and BlockPathRef.

Implementations

impl<T: AsRef<str>> BlockPathGen<T>

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.

impl BlockPathGen<String>

pub fn set_root(&mut self, new_root: Principal)

Sets the new_root as the root of this path.

pub fn push_component<T: Display>(&mut self, component: T)

Pushes the given component onto the end of this path. The Display trait is used to write the component at the end of this path.

pub fn pop_component(&mut self)

Removes the last component from this path. If there are no components (the path only has the root), then this method leaves the path unchanged.

Trait Implementations

impl<T: Clone> Clone for BlockPathGen<T>

fn clone(&self) -> BlockPathGen<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BlockPathGen<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for BlockPathGen<T>

fn default() -> BlockPathGen<T>

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BlockPathGen<&'de str>

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

Deserialize this value from the given Serde deserializer.

impl<'de> Deserialize<'de> for BlockPathGen<String>

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

Deserialize this value from the given Serde deserializer.

impl<T: AsRef<str>> Display for BlockPathGen<T>

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

Formats the value using the given formatter.

impl<T: AsRef<str>> Hash for BlockPathGen<T>

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<T: AsRef<str>> Ord for BlockPathGen<T>

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<T: AsRef<str>> PartialEq<BlockPathGen<T>> for BlockPathGen<T>

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<T: AsRef<str>, U: AsRef<str>> PartialEq<U> for BlockPathGen<T>

fn eq(&self, other: &U) -> 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<T: AsRef<str>> PartialOrd<BlockPathGen<T>> for BlockPathGen<T>

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<T: AsRef<str>> Serialize for BlockPathGen<T>

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

Serialize this value into the given Serde serializer.

impl<'s> TryFrom<&'s str> for BlockPathGen<&'s str>

type Error = BlockPathError

The type returned in the event of a conversion error.

fn try_from(value: &'s str) -> StdResult<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for BlockPathGen<String>

type Error = BlockPathError

The type returned in the event of a conversion error.

fn try_from(value: String) -> StdResult<Self, Self::Error>

Performs the conversion.

impl<T: AsRef<str>> Eq for BlockPathGen<T>