Skip to main content

PackedDoc

Struct PackedDoc 

Source
pub struct PackedDoc { /* private fields */ }
Expand description

Packed document container.

Implementations§

Source§

impl PackedDoc

Source

pub fn from_bytes(data: Vec<u8>) -> Result<Self, PackedDocError>

Construct a packed document from bytes and validate structural integrity.

Source

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

Return a borrowed view of the underlying bytes.

Source

pub fn into_bytes(self) -> Vec<u8>

Consume the packed document and return owned bytes.

Source

pub fn byte_size(&self) -> usize

Return total byte size.

Source

pub fn version(&self) -> Result<u16, PackedDocError>

Return packed format version.

Source

pub fn field_count(&self) -> Result<usize, PackedDocError>

Return number of fields in this packed document.

Source

pub fn updated_at(&self) -> Result<u32, PackedDocError>

Return document update timestamp.

Source

pub fn read_field( &self, field_id: FieldId, ) -> Result<Option<FieldValue>, PackedDocError>

Read a field by field ID.

Source

pub fn read_fields( &self, field_ids: &[FieldId], ) -> Result<Vec<Option<FieldValue>>, PackedDocError>

Read multiple fields in the order requested.

Source

pub fn iter_fields(&self) -> Result<PackedDocIter<'_>, PackedDocError>

Iterate over all packed fields in sorted field-id order.

Trait Implementations§

Source§

impl Clone for PackedDoc

Source§

fn clone(&self) -> PackedDoc

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PackedDoc

Source§

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

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

impl PartialEq for PackedDoc

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 StructuralPartialEq for PackedDoc

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, 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> 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.