Struct Entry 

pub struct Entry {
    pub sig: SigInfo,
    /* private fields */
}

Fields

sig: SigInfo

Authentication information for this entry

Implementations

impl Entry

pub fn builder(root: impl Into<ID>) -> EntryBuilder

Creates a new EntryBuilder for an entry associated with a specific tree root. This is a convenience method and preferred over calling EntryBuilder::new() directly.

Arguments

• root - The ID of the root Entry of the tree this entry will belong to.

pub fn root_builder() -> EntryBuilder

Creates a new EntryBuilder for a top-level (root) entry for a new tree. This is a convenience method and preferred over calling EntryBuilder::new_top_level() directly.

Root entries have an empty string as their root ID and include a special ROOT subtree marker. This method is typically used when creating a new tree.

pub fn id(&self) -> ID

Get the content-addressable ID of the entry.

The ID is calculated on demand by hashing the serialized JSON representation of the entry. Because entries are immutable once created and their contents are deterministically serialized, this ensures that identical entries will always have the same ID.

pub fn root(&self) -> ID

Get the ID of the root Entry of the tree this entry belongs to.

pub fn is_root(&self) -> bool

Check if this entry is a root entry (contains the ROOT marker and has no parents).

Root entries are the top-level entries in the database and are distinguished by:

1. Containing a subtree with the ROOT marker
2. Having no parent entries (they are true tree roots)

This ensures that root entries are actual starting points of trees in the DAG.

pub fn in_subtree(&self, subtree_name: impl AsRef<str>) -> bool

Check if this entry contains data for a specific named subtree.

pub fn in_tree(&self, tree_id: impl AsRef<str>) -> bool

Check if this entry belongs to a specific tree, identified by its root ID.

pub fn subtrees(&self) -> Vec<String>

Get the names of all subtrees this entry contains data for. The names are returned in alphabetical order.

pub fn metadata(&self) -> Option<&RawData>

Get the metadata associated with this entry’s tree node.

Metadata is optional information attached to an entry that is not part of the main data model and is not merged between entries.

pub fn data(&self, subtree_name: impl AsRef<str>) -> Result<&RawData>

Get the RawData for a specific named subtree within this entry.

Returns an error if the subtree is not found or if the subtree exists but has no data (None).

pub fn parents(&self) -> Result<Vec<ID>>

Get the IDs of the parent entries in the main tree history. The parent IDs are returned in alphabetical order.

pub fn subtree_parents(&self, subtree_name: impl AsRef<str>) -> Result<Vec<ID>>

Get the IDs of the parent entries specific to a named subtree’s history. The parent IDs are returned in alphabetical order.

pub fn height(&self) -> u64

Get the height of this entry in the main tree DAG.

pub fn subtree_height(&self, subtree_name: impl AsRef<str>) -> Result<u64>

Get the height of this entry in a specific subtree’s DAG.

If the subtree has an explicit height (Some(h)), that value is returned. If the subtree height is None, it inherits from the main tree height.

This allows subtrees to either track independent heights (for subtrees with their own height strategy) or share the tree’s height (default).

pub fn canonical_for_signing(&self) -> Self

Create a canonical representation of this entry for signing purposes.

This creates a copy of the entry with the signature field removed from auth, which is necessary for signature generation and verification. The returned entry has deterministic field ordering for consistent signatures.

pub fn canonical_bytes(&self) -> Result<Vec<u8>>

Create canonical bytes for signing or ID generation.

This method serializes the entry to JSON with deterministic field ordering. For signing purposes, call canonical_for_signing() first.

pub fn signing_bytes(&self) -> Result<Vec<u8>>

Create canonical bytes for signing (convenience method).

This combines canonical_for_signing() and canonical_bytes() for convenience.

pub fn validate(&self) -> Result<()>

Trait Implementations

impl Clone for Entry

fn clone(&self) -> Entry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Entry

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Entry

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Entry

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Entry

impl StructuralPartialEq for Entry