DocumentView

p2panda_rs::document

Struct DocumentView 

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

The materialised view of a Document. It’s fields match the documents schema definition.

DocumentViews are immutable versions of a Document. They represent a document at a certain point in time.

Implementations§

Source§

impl DocumentView

Source

pub fn new(id: &DocumentViewId, fields: &DocumentViewFields) -> Self

Construct a document view.

Requires the DocumentViewId and field values to be calculated seperately and then passed in during construction.

Source

pub fn id(&self) -> &DocumentViewId

Get the id of this document view.

Source

pub fn get(&self, key: &str) -> Option<&DocumentViewValue>

Get a single value from this instance by it’s key.

Source

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

Returns a vector containing the keys of this instance.

Source

pub fn iter(&self) -> BTreeMapIter<'_, String, DocumentViewValue>

Returns an iterator of existing instance fields.

Source

pub fn len(&self) -> usize

Returns the number of fields on this instance.

Source

pub fn is_empty(&self) -> bool

Returns true if the instance is empty, otherwise false.

Source

pub fn fields(&self) -> &DocumentViewFields

Returns the fields of this document view.

Trait Implementations§

Source§

impl Clone for DocumentView

Source§

fn clone(&self) -> DocumentView

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 DocumentView

Source§

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

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

impl Display for DocumentView

Source§

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

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

impl Human for DocumentView

Source§

fn display(&self) -> String

Returns a shorter representation of the type. Read more
Source§

impl PartialEq for DocumentView

Source§

fn eq(&self, other: &DocumentView) -> 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 TryFrom<DocumentView> for SchemaFieldView

Source§

type Error = SystemSchemaError

The type returned in the event of a conversion error.
Source§

fn try_from(document_view: DocumentView) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl TryFrom<DocumentView> for SchemaView

Source§

type Error = SystemSchemaError

The type returned in the event of a conversion error.
Source§

fn try_from(document_view: DocumentView) -> Result<Self, Self::Error>

Performs the conversion.
Source§

impl StructuralPartialEq for DocumentView

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V