Struct MetadataFrameRef 

pub struct MetadataFrameRef<'rx> { /* private fields */ }

A zero-copy borrowed metadata frame.

This type wraps an RAII guard that owns the NDI frame buffer lifetime, exposing a safe, zero-copy view of the metadata string. The frame is automatically freed when dropped via NDIlib_recv_free_metadata.

Key characteristics:

• Zero allocations: References NDI SDK buffers directly
• Zero copies: No string duplication
• RAII lifetime: Exactly one free per frame, enforced at compile time
• Not Send: Prevents accidental cross-thread use of FFI buffers

Examples

// Zero-copy capture
if let Some(frame) = receiver.metadata().try_capture_ref(Duration::from_millis(1000))? {
    println!("Metadata: {}", frame.data());

    // Frame is freed here when `frame` goes out of scope
}

Implementations

impl<'rx> MetadataFrameRef<'rx>

pub fn timecode(&self) -> i64

Get the timecode.

pub fn data(&self) -> &str

Get a zero-copy view of the metadata text.

This returns a reference directly into the NDI SDK’s buffer. No allocation or string copying is performed.

pub fn as_bytes(&self) -> &[u8]

Get a zero-copy view of the metadata UTF-8 payload bytes, excluding the SDK trailing NUL terminator.

pub fn to_owned(&self) -> MetadataFrame

Convert this borrowed frame to an owned MetadataFrame.

This performs a string copy, allowing the frame to outlive the NDI buffer and be sent across threads.

Trait Implementations

impl<'rx> Debug for MetadataFrameRef<'rx>

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

Formats the value using the given formatter.