Struct OwnedNodeRef 

pub struct OwnedNodeRef { /* private fields */ }

A decoded node that owns its decompressed buffer. The inner NodeRef borrows string/byte payloads directly from the buffer, avoiding copies. Container allocations (attribute Vec, child Vec) still occur during decode.

Wrap in Arc<OwnedNodeRef> for cheap sharing across handlers.

Implementations

impl OwnedNodeRef

pub fn new(buffer: impl Into<Bytes>) -> Result<OwnedNodeRef, BinaryError>

Decode a node from an owned buffer. The buffer should be the raw binary-protocol bytes (after decompression, without the leading format byte which unpack already strips).

pub fn get(&self) -> &NodeRef<'_>

Access the borrowed node.

pub fn to_owned_node(&self) -> Node

Convert to an owned Node, cloning all data out of the buffer. Use sparingly — this is the allocation path that yoke is designed to avoid.

pub fn slice_bytes(&self, slice: &[u8]) -> Bytes

Return a zero-copy Bytes sub-view for a slice that borrows from this node’s backing buffer. Panics if slice does not point within the buffer.

pub fn tag(&self) -> &str

The tag name of this node.

pub fn attrs(&self) -> AttrParserRef<'_>

Get an attribute parser for this node.

pub fn get_attr(&self, key: &str) -> Option<&ValueRef<'_>>

Look up a single attribute by key.

pub fn children(&self) -> Option<&[NodeRef<'_>]>

Get child nodes, if content is a node list.

pub fn get_optional_child(&self, tag: &str) -> Option<&NodeRef<'_>>

Find a child node by tag.

pub fn get_optional_child_by_tag(&self, tags: &[&str]) -> Option<&NodeRef<'_>>

Find a child by traversing a path of tags.

pub fn get_children_by_tag<'b>( &'b self, tag: &'b str, ) -> impl Iterator<Item = &'b NodeRef<'b>>

Get children matching a tag.

pub fn content_bytes(&self) -> Option<&[u8]>

Zero-copy byte content, if this node has Bytes content.

pub fn content_str(&self) -> Option<&str>

Zero-copy string content, if this node has String content.

pub fn content_nodes(&self) -> Option<&[NodeRef<'_>]>

Child nodes from content, if this node has Nodes content.

pub fn content_as_string(&self) -> Option<CompactString>

Extract text content, handling both String and Bytes (lossy UTF-8).

Trait Implementations

impl Debug for OwnedNodeRef

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

Formats the value using the given formatter.

impl Serialize for OwnedNodeRef

Available on crate feature serde only.

fn serialize<S>( &self, serializer: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.