Struct PrivatePathContext 

pub struct PrivatePathContext<const MCL: usize, const MCC: usize, const MPL: usize> { /* private fields */ }

The immutable PrivatePathContext necessary to privately encode a Path relative to one of its prefixes, while keeping secret all Components that coincide with a third Path.

Implementations

impl<const MCL: usize, const MCC: usize, const MPL: usize> PrivatePathContext<MCL, MCC, MPL>

pub fn new( private: Path<MCL, MCC, MPL>, rel: Path<MCL, MCC, MPL>, ) -> Result<Self, ComponentsNotRelatedError>

Returns a new PrivatePathContext with the given private and relative paths.

Will return a ComponentsNotRelatedError if the given private and relative paths are not related.

pub unsafe fn new_unchecked( private: Path<MCL, MCC, MPL>, rel: Path<MCL, MCC, MPL>, ) -> Self

Returns a new PrivatePathContext with the given private and relative paths without checking if the given private and relative paths are related.

Safety

Undefined behaviour if private and rel are not related.

pub fn private(&self) -> &Path<MCL, MCC, MPL>

Returns the private path of &self.

pub fn rel(&self) -> &Path<MCL, MCC, MPL>

Returns the relative path of &self.

Trait Implementations

impl<'a, const MCL: usize, const MCC: usize, const MPL: usize> Arbitrary<'a> for PrivatePathContext<MCL, MCC, MPL>

Available on crate feature dev only.

fn arbitrary(u: &mut Unstructured<'a>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl<const MCL: usize, const MCC: usize, const MPL: usize> Clone for PrivatePathContext<MCL, MCC, MPL>

fn clone(&self) -> PrivatePathContext<MCL, MCC, MPL>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const MCL: usize, const MCC: usize, const MPL: usize> Debug for PrivatePathContext<MCL, MCC, MPL>

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

Formats the value using the given formatter.

impl<const MCL: usize, const MCC: usize, const MPL: usize> Hash for PrivatePathContext<MCL, MCC, MPL>

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<const MCL: usize, const MCC: usize, const MPL: usize> Ord for PrivatePathContext<MCL, MCC, MPL>

fn cmp(&self, other: &PrivatePathContext<MCL, MCC, MPL>) -> 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.

impl<const MCL: usize, const MCC: usize, const MPL: usize> PartialEq for PrivatePathContext<MCL, MCC, MPL>

fn eq(&self, other: &PrivatePathContext<MCL, MCC, MPL>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl<const MCL: usize, const MCC: usize, const MPL: usize> PartialOrd for PrivatePathContext<MCL, MCC, MPL>

fn partial_cmp( &self, other: &PrivatePathContext<MCL, MCC, MPL>, ) -> 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.

impl<const MCL: usize, const MCC: usize, const MPL: usize> RelativeDecodable<PrivatePathContext<MCL, MCC, MPL>> for Path<MCL, MCC, MPL>

type ErrorReason = Blame

Reason why decoding can fail (beyond an unexpected end of input or a producer error).

async fn relative_decode<P>( rel: &PrivatePathContext<MCL, MCC, MPL>, producer: &mut P, ) -> Result<Self, DecodeError<P::Final, P::Error, Self::ErrorReason>>

where P: BulkProducer<Item = u8> + ?Sized, Self: Sized,

Decodes the symbols produced by the given bulk producer relative to rel into a Self, or yields an error if the producer does not produce a valid relative encoding.

impl<const MCL: usize, const MCC: usize, const MPL: usize> RelativeEncodable<PrivatePathContext<MCL, MCC, MPL>> for Path<MCL, MCC, MPL>

fn can_be_encoded_relative_to( &self, rel: &PrivatePathContext<MCL, MCC, MPL>, ) -> bool

Fails if the path is not a prefix of rel.rel, OR if self is not related to to rel.private.

async fn relative_encode<C>( &self, rel: &PrivatePathContext<MCL, MCC, MPL>, consumer: &mut C, ) -> Result<(), C::Error>

where C: BulkConsumer<Item = u8> + ?Sized,

Writes an encoding of &self relative to rel into the given bulk consumer.

impl<const MCL: usize, const MCC: usize, const MPL: usize> Eq for PrivatePathContext<MCL, MCC, MPL>

impl<const MCL: usize, const MCC: usize, const MPL: usize> StructuralPartialEq for PrivatePathContext<MCL, MCC, MPL>