aws_smithy_types

Enum Document

Source
pub enum Document {
    Object(HashMap<String, Document>),
    Array(Vec<Document>),
    Number(Number),
    String(String),
    Bool(bool),
    Null,
}
Expand description

Document Type

Document types represents protocol-agnostic open content that is accessed like JSON data. Open content is useful for modeling unstructured data that has no schema, data that can’t be modeled using rigid types, or data that has a schema that evolves outside of the purview of a model. The serialization format of a document is an implementation detail of a protocol.

Variants§

§

Object(HashMap<String, Document>)

JSON object

§

Array(Vec<Document>)

JSON array

§

Number(Number)

JSON number

§

String(String)

JSON string

§

Bool(bool)

JSON boolean

§

Null

JSON null

Implementations§

Source§

impl Document

Source

pub fn as_object(&self) -> Option<&HashMap<String, Document>>

Returns the inner map value if this Document is an object.

Source

pub fn as_object_mut(&mut self) -> Option<&mut HashMap<String, Document>>

Returns the mutable inner map value if this Document is an object.

Source

pub fn as_array(&self) -> Option<&Vec<Document>>

Returns the inner array value if this Document is an array.

Source

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Document>>

Returns the mutable inner array value if this Document is an array.

Source

pub fn as_number(&self) -> Option<&Number>

Returns the inner number value if this Document is a number.

Source

pub fn as_string(&self) -> Option<&str>

Returns the inner string value if this Document is a string.

Source

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

Returns the inner boolean value if this Document is a boolean.

Source

pub fn as_null(&self) -> Option<()>

Returns Some(()) if this Document is a null.

Source

pub fn is_object(&self) -> bool

Returns true if this Document is an object.

Source

pub fn is_array(&self) -> bool

Returns true if this Document is an array.

Source

pub fn is_number(&self) -> bool

Returns true if this Document is a number.

Source

pub fn is_string(&self) -> bool

Returns true if this Document is a string.

Source

pub fn is_bool(&self) -> bool

Returns true if this Document is a bool.

Source

pub fn is_null(&self) -> bool

Returns true if this Document is a boolean.

Trait Implementations§

Source§

impl Clone for Document

Source§

fn clone(&self) -> Document

Returns a copy 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 Document

Source§

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

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

impl Default for Document

The default value is Document::Null.

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'a> From<&'a str> for Document

Source§

fn from(value: &'a str) -> Self

Converts to this type from the input type.
Source§

impl<'a> From<Cow<'a, str>> for Document

Source§

fn from(value: Cow<'a, str>) -> Self

Converts to this type from the input type.
Source§

impl From<HashMap<String, Document>> for Document

Source§

fn from(values: HashMap<String, Document>) -> Self

Converts to this type from the input type.
Source§

impl From<Number> for Document

Source§

fn from(value: Number) -> Self

Converts to this type from the input type.
Source§

impl From<String> for Document

Source§

fn from(value: String) -> Self

Converts to this type from the input type.
Source§

impl From<Vec<Document>> for Document

Source§

fn from(values: Vec<Document>) -> Self

Converts to this type from the input type.
Source§

impl From<bool> for Document

Source§

fn from(value: bool) -> Self

Converts to this type from the input type.
Source§

impl From<f64> for Document

Source§

fn from(value: f64) -> Self

Converts to this type from the input type.
Source§

impl From<i32> for Document

Source§

fn from(value: i32) -> Self

Converts to this type from the input type.
Source§

impl From<i64> for Document

Source§

fn from(value: i64) -> Self

Converts to this type from the input type.
Source§

impl From<u64> for Document

Source§

fn from(value: u64) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for Document

Source§

fn eq(&self, other: &Document) -> 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 Document

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, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> 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.