Struct DocumentRef 

#[non_exhaustive]
pub struct DocumentRef<'a> {
    pub flags: u8,
    pub collection: &'a str,
    pub doc_id: &'a str,
    pub timestamp_ms: i64,
    pub body: &'a [u8],
}

Decoded view of a Document envelope, borrowing from the input buffer. Hot-path-friendly for no_std consumers — no allocation.

Marked #[non_exhaustive] so future protocol amendments can add fields (e.g. fragmentation sequence number) without breaking downstream DocumentRef { ... } literal constructions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

flags: u8

Flags byte. See DOC_FLAG_TOMBSTONE / DOC_FLAG_ENCRYPTED.

collection: &'a str

Collection name as UTF-8 bytes (validated UTF-8 on decode).

doc_id: &'a str

Document id as UTF-8 bytes; empty slice means “publisher delegated id assignment to the receiver.”

timestamp_ms: i64

Unix epoch milliseconds.

body: &'a [u8]

Opaque body bytes — peat-lite does not interpret.

Implementations

impl<'a> DocumentRef<'a>

pub fn is_tombstone(&self) -> bool

Returns true if the deletion-tombstone flag is set.

pub fn is_encrypted(&self) -> bool

Returns true if the encrypted-body flag is set.

Trait Implementations

impl<'a> Clone for DocumentRef<'a>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for DocumentRef<'a>

impl<'a> Debug for DocumentRef<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for DocumentRef<'a>

impl<'a> PartialEq for DocumentRef<'a>

fn eq(&self, other: &DocumentRef<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for DocumentRef<'a>