Struct PathDecl 

pub struct PathDecl {
    pub n: u8,
    pub paths: PathDeclPaths,
}

A path declaration: key count n plus either a shared origin path or n divergent origin paths (mode selected by header bit 4).

Fields

n: u8

Key count, 1..=32 (encoded on the wire as n - 1 in 5 bits).

paths: PathDeclPaths

Path payload — shared (single path) or divergent (one per key).

Implementations

impl PathDecl

pub fn write(&self, w: &mut BitWriter) -> Result<(), Error>

Encode this PathDecl into w. The mode (shared vs divergent) is determined by self.paths; the caller is responsible for setting header bit 4 to match.

Errors

• Error::KeyCountOutOfRange if self.n is outside 1..=32.
• Error::DivergentPathCountMismatch if self.paths is Divergent and the vector length does not equal self.n.
• Error::PathDepthExceeded propagated from a component’s path encoder if any contained path exceeds MAX_PATH_COMPONENTS.

pub fn read(r: &mut BitReader<'_>, divergent_mode: bool) -> Result<Self, Error>

Decode a PathDecl from r using divergent_mode (header bit 4).

Trait Implementations

impl Clone for PathDecl

fn clone(&self) -> PathDecl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PathDecl

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

Formats the value using the given formatter.

impl PartialEq for PathDecl

fn eq(&self, other: &PathDecl) -> 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 Eq for PathDecl

impl StructuralPartialEq for PathDecl