Struct btlib::BlockPath

pub struct BlockPath(_);

An owned identifier for a block in a tree.

Implementations

impl BlockPath

pub const SEP: char = '/'

The character that is used to separate path components. pub const SEP: char = ‘/’;

pub const BYTE_LIMIT: usize = 4_096usize

The limit, in bytes, to a path’s length.

pub fn new(path: String) -> StdResult<BlockPath, BlockPathError>

Returns a path with the given root and the given components.

pub fn from_components<'a, I: Iterator<Item = &'a str>>( root: Principal, components: I ) -> Self

Creates a BlockPath which contains the given root and components.

pub fn borrow(&self) -> BlockPathRef<'_>

Returns a reference to this block path.

Methods from Deref<Target = BlockPathGen<String>>

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.

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 Clone for BlockPath

fn clone(&self) -> BlockPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockPath

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

Formats the value using the given formatter.

impl Default for BlockPath

fn default() -> BlockPath

Returns the “default value” for a type.

impl Deref for BlockPath

type Target = BlockPathGen<String>

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for BlockPath

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de> Deserialize<'de> for BlockPath

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

Deserialize this value from the given Serde deserializer.

impl Display for BlockPath

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

Formats the value using the given formatter.

impl FromStr for BlockPath

type Err = BlockPathError

The associated error which can be returned from parsing.

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

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

impl Hash for BlockPath

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 BlockPath

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 PartialEq<BlockPath> for BlockPath

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>> PartialEq<T> for BlockPath

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 PartialOrd<BlockPath> for BlockPath

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 Serialize for BlockPath

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 BlockPath

type Error = BlockPathError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<String> for BlockPath

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 Eq for BlockPath