Skip to main content

MantarayNode

Struct MantarayNode 

Source
pub struct MantarayNode {
    pub obfuscation_key: [u8; 32],
    pub self_address: Option<[u8; 32]>,
    pub target_address: [u8; 32],
    pub metadata: Option<BTreeMap<String, String>>,
    pub path: Vec<u8>,
    pub forks: BTreeMap<u8, Fork>,
}
Expand description

One node of the Mantaray trie. Field names mirror bee-js / bee-go.

  • obfuscation_key: 32-byte XOR mask used when serializing this node. Freshly-constructed nodes use a zero key.
  • self_address: chunk address of the marshaled node, populated after crate::manifest::wire::calculate_self_address / save_recursively. None means “not computed”.
  • target_address: file reference at this node, or NULL_ADDRESS for pure directory nodes.
  • path: edge label inherited from the parent fork’s prefix; the root has an empty path.
  • forks: child edges keyed by first prefix byte (ordered by key).
  • metadata: optional key/value annotations carried in the wire format; ordered by key so JSON serialization is deterministic.

Fields§

§obfuscation_key: [u8; 32]

32-byte XOR mask used during marshal.

§self_address: Option<[u8; 32]>

Chunk address of the marshaled node, when known.

§target_address: [u8; 32]

File reference at this node (32 bytes; NULL_ADDRESS = none).

§metadata: Option<BTreeMap<String, String>>

Optional metadata annotations.

§path: Vec<u8>

Edge label inherited from the parent fork.

§forks: BTreeMap<u8, Fork>

Child edges keyed by first prefix byte.

Implementations§

Source§

impl MantarayNode

Source

pub fn new() -> Self

Empty Mantaray root.

Source

pub fn is_null_target(&self) -> bool

True iff this node’s target_address is the null address.

Source

pub fn determine_type(&self) -> u8

Pack the type bitfield used in this node’s outgoing fork record.

Source

pub fn find_closest<'a>(&'a self, path: &[u8]) -> (&'a MantarayNode, Vec<u8>)

Walk down forks while path matches. Returns the deepest node reached and the bytes of path matched along the way.

Source

pub fn find(&self, path: &[u8]) -> Option<&MantarayNode>

Return the node whose full path equals path, or None.

Source

pub fn collect(&self) -> Vec<(Vec<u8>, &MantarayNode)>

All descendants whose target_address is non-null, with their full paths. The path is the concatenation of every fork prefix from the root down to the node.

Source

pub fn collect_and_map(&self) -> HashMap<String, Reference>

{full_path: reference} for every leaf with a valid reference. Mirrors bee-go CollectAndMap.

Source

pub fn add_fork( &mut self, path: &[u8], target: Option<&Reference>, metadata: Option<&BTreeMap<String, String>>, )

Insert a (path, target, metadata) entry. Long paths are chunked into chained nodes of up to MAX_PREFIX_LENGTH bytes each. Metadata is attached to the terminal node only.

Invalidates self_address on every node touched along the way; call calculate_self_address (or save_recursively) before marshaling.

Source

pub fn remove_fork(&mut self, path: &[u8]) -> Result<(), Error>

Delete the fork rooted at path. If the removed node had children, they are re-inserted under the parent so the trie stays consistent.

Trait Implementations§

Source§

impl Clone for MantarayNode

Source§

fn clone(&self) -> MantarayNode

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MantarayNode

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for MantarayNode

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for MantarayNode

Source§

fn eq(&self, other: &MantarayNode) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl Eq for MantarayNode

Source§

impl StructuralPartialEq for MantarayNode

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more