[][src]Enum templar::Document

pub enum Document {
    Bool(bool),
    U8(u8),
    U16(u16),
    U32(u32),
    U64(u64),
    U128(u128),
    I8(i8),
    I16(i16),
    I32(i32),
    I64(i64),
    I128(i128),
    F32(f32),
    F64(f64),
    Char(char),
    String(String),
    Unit,
    Option(Option<Box<Document>>),
    Newtype(Box<Document>),
    Seq(Vec<Document>),
    Map(BTreeMap<Document, Document>),
    Bytes(Vec<u8>),
}

Variants

Bool(bool)
U8(u8)
U16(u16)
U32(u32)
U64(u64)
U128(u128)
I8(i8)
I16(i16)
I32(i32)
I64(i64)
I128(i128)
F32(f32)
F64(f64)
Char(char)
String(String)
Unit
Option(Option<Box<Document>>)
Newtype(Box<Document>)
Bytes(Vec<u8>)

Implementations

impl Document[src]

pub fn is_i8(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_i8(&self) -> Option<i8>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_i8(&mut self) -> Option<i8>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_i16(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_i16(&self) -> Option<i16>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_i16(&mut self) -> Option<i16>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_i32(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_i32(&self) -> Option<i32>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_i32(&mut self) -> Option<i32>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_i64(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_i64(&self) -> Option<i64>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_i64(&mut self) -> Option<i64>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_i128(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_i128(&self) -> Option<i128>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_i128(&mut self) -> Option<i128>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_u8(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_u8(&self) -> Option<u8>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_u8(&mut self) -> Option<u8>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_u16(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_u16(&self) -> Option<u16>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_u16(&mut self) -> Option<u16>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_u32(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_u32(&self) -> Option<u32>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_u32(&mut self) -> Option<u32>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_u64(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_u64(&self) -> Option<u64>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_u64(&mut self) -> Option<u64>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_u128(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_u128(&self) -> Option<u128>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_u128(&mut self) -> Option<u128>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_f32(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_f32(&self) -> Option<f32>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_f32(&mut self) -> Option<f32>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_f64(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_f64(&self) -> Option<f64>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_f64(&mut self) -> Option<f64>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_bool(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_bool(&self) -> Option<bool>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_bool(&mut self) -> Option<bool>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_char(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_char(&self) -> Option<char>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_char(&mut self) -> Option<char>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_string(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_string(&self) -> Option<String>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_string(&mut self) -> Option<String>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_map(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_map(&self) -> Option<BTreeMap<Document, Document>>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_map(&mut self) -> Option<BTreeMap<Document, Document>>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_option(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_option(&self) -> Option<Option<Box<Document>>>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_option(&mut self) -> Option<Option<Box<Document>>>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_bytes(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_bytes(&self) -> Option<Vec<u8>>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_bytes(&mut self) -> Option<Vec<u8>>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_seq(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_seq(&self) -> Option<Vec<Document>>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_seq(&mut self) -> Option<Vec<Document>>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn is_newtype(&self) -> bool[src]

Check whether this Document is a $r

pub fn as_newtype(&self) -> Option<Box<Document>>[src]

Retrieve the value of this Document as $r . This will return None if the document type is not Document::$v

pub fn take_newtype(&mut self) -> Option<Box<Document>>[src]

Move the value of this document out of the object if is is an $r. This will return None and leave the Document unchanged if the type does not match. When the value is moved out, a Document::Unit is left in its place.

pub fn get_path<T>(&self, path: &[&T]) -> &Document where
    T: Index, 
[src]

pub fn set_path<T, U>(&mut self, val: U, path: &[&T]) where
    T: Index,
    U: Into<Document>, 
[src]

pub fn set<U>(&mut self, val: U) where
    U: Into<Document>, 
[src]

pub fn replace(&mut self, new_val: Document) -> Document[src]

pub fn take(&mut self) -> Document[src]

pub fn is_unit(&self) -> bool[src]

pub fn is_number(&self) -> bool[src]

pub fn is_signed(&self) -> bool[src]

Returns true if the value is any signed integer (i8, i16, i32, i64)

pub fn is_unsigned(&self) -> bool[src]

Returns true if the value is any unsigned integer (u8, u16, u32, u64)

pub fn is_float(&self) -> bool[src]

Returns true if the value is any float (f32, f64)

pub fn as_usize(&self) -> Option<usize>[src]

pub fn try_into<'de, T>(self) -> Result<T, DeserializerError> where
    T: Deserialize<'de>, 
[src]

This attempts to deserialize the document into a type that implements Deserialize

pub fn new<T>(value: T) -> Result<Document, SerializerError> where
    T: Serialize
[src]

This creates a new document from a type that implements Serialize

pub fn merge(&mut self, other: Document)[src]

Merge another document into this one, consuming both documents into the result. If this document is not a map or seq, it will be overwritten. If this document is a seq and the other is also a seq, the other seq will be appended to the end of this one. If the other document is not a seq, then it will be appended to the end of the sequence in this one. If this document is a map and the other document is also be a map, merging maps will cause values from the other document to overwrite this one. Otherwise, the value from the other document will overwrite this one.

Trait Implementations

impl Add<Document> for Document[src]

type Output = Document

The resulting type after applying the + operator.

impl Clone for Document[src]

impl Debug for Document[src]

impl Default for Document[src]

impl<'de> Deserialize<'de> for Document[src]

impl<'de> Deserializer<'de> for Document[src]

type Error = DeserializerError

The error type that can be returned if some error occurs during deserialization. Read more

impl Display for Document[src]

impl Eq for Document[src]

impl<'_> From<&'_ BTreeMap<Document, Document>> for Document[src]

impl<'_> From<&'_ String> for Document[src]

impl<'_> From<&'_ Vec<Document>> for Document[src]

impl<'_> From<&'_ Vec<u8>> for Document[src]

impl<'_> From<&'_ bool> for Document[src]

impl<'_> From<&'_ char> for Document[src]

impl<'_> From<&'_ f32> for Document[src]

impl<'_> From<&'_ f64> for Document[src]

impl<'_> From<&'_ i128> for Document[src]

impl<'_> From<&'_ i16> for Document[src]

impl<'_> From<&'_ i32> for Document[src]

impl<'_> From<&'_ i64> for Document[src]

impl<'_> From<&'_ i8> for Document[src]

impl<'_> From<&'_ isize> for Document[src]

impl<'_> From<&'_ str> for Document[src]

impl<'_> From<&'_ u128> for Document[src]

impl<'_> From<&'_ u16> for Document[src]

impl<'_> From<&'_ u32> for Document[src]

impl<'_> From<&'_ u64> for Document[src]

impl<'_> From<&'_ u8> for Document[src]

impl<'_> From<&'_ usize> for Document[src]

impl From<BTreeMap<Document, Document>> for Document[src]

impl From<String> for Document[src]

impl From<Vec<Document>> for Document[src]

impl From<Vec<u8>> for Document[src]

impl From<bool> for Document[src]

impl From<char> for Document[src]

impl From<f32> for Document[src]

impl From<f64> for Document[src]

impl From<i128> for Document[src]

impl From<i16> for Document[src]

impl From<i32> for Document[src]

impl From<i64> for Document[src]

impl From<i8> for Document[src]

impl From<u128> for Document[src]

impl From<u16> for Document[src]

impl From<u32> for Document[src]

impl From<u64> for Document[src]

impl From<u8> for Document[src]

impl Hash for Document[src]

impl<I> Index<I> for Document where
    I: Index, 
[src]

type Output = Document

The returned type after indexing.

impl<I> IndexMut<I> for Document where
    I: Index, 
[src]

impl<'de> IntoDeserializer<'de, DeserializerError> for Document[src]

type Deserializer = Document

The type of the deserializer being converted into.

impl Ord for Document[src]

impl PartialEq<Document> for Document[src]

impl PartialEq<String> for Document[src]

impl PartialEq<bool> for Document[src]

impl PartialEq<char> for Document[src]

impl PartialEq<f32> for Document[src]

impl PartialEq<f64> for Document[src]

impl PartialEq<i16> for Document[src]

impl PartialEq<i32> for Document[src]

impl PartialEq<i64> for Document[src]

impl PartialEq<i8> for Document[src]

impl PartialEq<str> for Document[src]

impl PartialEq<u16> for Document[src]

impl PartialEq<u32> for Document[src]

impl PartialEq<u64> for Document[src]

impl PartialEq<u8> for Document[src]

impl PartialOrd<Document> for Document[src]

impl Serialize for Document[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> DeserializeOwned for T where
    T: for<'de> Deserialize<'de>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.