Struct qldb::Document

pub struct Document { /* private fields */ }

It contains the IonValue representing the QLDB Document.

It contains methods that will extract and try to transfor the IonValue to your type.

use qldb::{QldbExtractResult, Document};

fn test(document: Document) -> QldbExtractResult<u64> {

    let points: u64 = document.get_value("points")?;

    Ok(points)
}

Implementations

impl Document

pub fn get_value<T>(&self, name: &str) -> QldbExtractResult<T> where
    T: TryFrom<IonValue> + Send + Sync + Clone,
    <T as TryFrom<IonValue>>::Error: Error + Send + Sync + 'static, 

Extract a value from the document and tries to transform to the value of the return type. Fails if the property is not there.

pub fn get(&self, name: &str) -> Option<&IonValue>

Gets the raw IonValue

pub fn get_optional_value<T>(&self, name: &str) -> QldbExtractResult<Option<T>> where
    T: TryFrom<IonValue> + Send + Sync + Clone,
    <T as TryFrom<IonValue>>::Error: Error + Send + Sync + 'static, 

Same as extract_value but it returns None if the property is not there.

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Extend<Document> for DocumentCollection

fn extend<T: IntoIterator<Item = Document>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl PartialEq<Document> for Document

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl TryFrom<IonValue> for Document

type Error = QldbExtractError

The type returned in the event of a conversion error.

fn try_from(value: IonValue) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Document