Struct ExportedTree 

pub struct ExportedTree<'a>(/* private fields */);

Implementations

impl<'a> ExportedTree<'a>

pub fn to_bytes(&self) -> Result<Vec<u8>, MlsError>

pub fn byte_size(&self) -> usize

pub fn into_owned(self) -> ExportedTree<'static>

pub fn roster(&'a self) -> Roster<'a>

pub fn nodes(&self) -> &[Option<Node>]

Returns a reference to the underlying vector of nodes in the tree.

Each element is None for a blank node, or Some(Node) for an occupied leaf or parent node. Nodes are indexed by NodeIndex where even indices are leaves and odd indices are parent nodes.

pub fn filtered_direct_path( &self, index: LeafIndex, ) -> Result<Vec<Option<&Parent>>, MlsError>

Returns the filtered direct path for a given leaf index as a vector of Option<&Parent> nodes.

Per RFC 9420 Section 8.4, the filtered direct path removes all nodes whose child on the copath has an empty resolution. Each entry is None if the parent node at that position is blank, or Some(&Parent) if it is populated.

pub fn get_parent(&self, index: NodeIndex) -> Result<Option<&Parent>, MlsError>

Returns the parent node at the given NodeIndex, or None if the node is blank or is a leaf node. Returns an error if the index is out of range.

pub fn get_leaf(&self, index: LeafIndex) -> Result<Option<&LeafNode>, MlsError>

Returns the leaf node at the given LeafIndex, or None if the leaf slot is blank. Returns an error if the index is out of range.

impl ExportedTree<'static>

pub fn from_bytes(bytes: &[u8]) -> Result<Self, MlsError>

Trait Implementations

impl<'a> Clone for ExportedTree<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ExportedTree<'a>

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

Formats the value using the given formatter.

impl From<ExportedTree<'_>> for NodeVec

fn from(value: ExportedTree<'_>) -> Self

Converts to this type from the input type.

impl<'a> MlsDecode for ExportedTree<'a>

fn mls_decode(reader: &mut &[u8]) -> Result<Self, Error>

impl<'a> MlsEncode for ExportedTree<'a>

fn mls_encode(&self, writer: &mut Vec<u8>) -> Result<(), Error>

fn mls_encode_to_vec(&self) -> Result<Vec<u8>, Error>

impl<'a> MlsSize for ExportedTree<'a>

fn mls_encoded_len(&self) -> usize

impl<'a> PartialEq for ExportedTree<'a>

fn eq(&self, other: &ExportedTree<'a>) -> 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<'a> StructuralPartialEq for ExportedTree<'a>