Enum aws_smithy_types::Document

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

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

impl Document

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

pub fn is_object(&self) -> bool

Returns true if this Document is an object.

pub fn is_array(&self) -> bool

Returns true if this Document is an array.

pub fn is_number(&self) -> bool

Returns true if this Document is a number.

pub fn is_string(&self) -> bool

Returns true if this Document is a string.

pub fn is_bool(&self) -> bool

Returns true if this Document is a bool.

pub fn is_null(&self) -> bool

Returns true if this Document is a boolean.

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 Default for Document

The default value is Document::Null.

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<Number> for Document

fn from(value: Number) -> Self

Converts to this type from the input type.

impl From<String> for Document

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<Vec<Document>> for Document

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

Converts to this type from the input type.

impl From<bool> for Document

fn from(value: bool) -> Self

Converts to this type from the input type.

impl From<f64> for Document

fn from(value: f64) -> Self

Converts to this type from the input type.

impl From<i32> for Document

fn from(value: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Document

fn from(value: i64) -> Self

Converts to this type from the input type.

impl From<u64> for Document

fn from(value: u64) -> Self

Converts to this type from the input type.

impl PartialEq 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: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Document