Struct DocumentShapeDeserializer 

pub struct DocumentShapeDeserializer<'a> { /* private fields */ }

Walks a [Document] tree via the ShapeDeserializer interface.

See the module-level documentation for an overview.

Example

Use DiscriminatedDocument::as_shape for the common case of consuming a DiscriminatedDocument via a generated deserialize method:

use aws_smithy_schema::document::DiscriminatedDocumentExt;

let person: Person = doc.as_shape(|deser| Person::deserialize(deser))?;

Direct construction is useful when consuming a sub-document outside the standard entry point:

use aws_smithy_schema::document::DocumentShapeDeserializer;
use aws_smithy_schema::serde::ShapeDeserializer;

let mut deser = DocumentShapeDeserializer::new(&doc);
let s = deser.read_string(&aws_smithy_schema::prelude::STRING)?;

Implementations

impl<'a> DocumentShapeDeserializer<'a>

pub fn new(document: &'a Document) -> Self

Creates a deserializer positioned at the given document.

The lifetime parameter is the borrow lifetime of document — the cursor is just a &Document. [Document] itself has no lifetime parameter (it is fully owned), so this 'a is purely the per-call borrow lifetime.

No format-aware coercion is performed; this deserializer is variant-only. For coercion of wire-encoded blobs and timestamps (e.g. JSON’s base64-string blobs, epoch-seconds-number timestamps), use Self::new_with_settings.

pub fn new_with_settings( document: &'a Document, settings: Option<Arc<dyn DocumentSettings>>, ) -> Self

Creates a deserializer positioned at the given document with codec settings attached.

With settings present, Self::read_blob and Self::read_timestamp consult the settings to coerce non-native variants — JSON wire bytes encode blobs as base64 strings and may encode timestamps as strings or numbers, so a document parsed from JSON via crate::codec::Codec::create_deserializer needs settings for those round-trips to succeed.

Trait Implementations

impl<'a> Debug for DocumentShapeDeserializer<'a>

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

Formats the value using the given formatter.

impl<'a> ShapeDeserializer for DocumentShapeDeserializer<'a>

fn skip_value(&mut self) -> Result<(), SerdeError>

Nothing to advance. The cursor points at an already-parsed node of an owned document tree, and read_struct hands each member its own sub-deserializer, so declining a value has no effect on the parent’s iteration.

fn read_struct( &mut self, schema: &Schema<'_>, consumer: &mut dyn FnMut(&Schema<'_>, &mut dyn ShapeDeserializer) -> Result<(), SerdeError>, ) -> Result<(), SerdeError>

Reads a structure from the deserializer.

fn read_list( &mut self, _schema: &Schema<'_>, consumer: &mut dyn FnMut(&mut dyn ShapeDeserializer) -> Result<(), SerdeError>, ) -> Result<(), SerdeError>

Reads a list from the deserializer.

fn read_map( &mut self, _schema: &Schema<'_>, consumer: &mut dyn FnMut(String, &mut dyn ShapeDeserializer) -> Result<(), SerdeError>, ) -> Result<(), SerdeError>

Reads a map from the deserializer.

fn read_boolean(&mut self, _schema: &Schema<'_>) -> Result<bool, SerdeError>

Reads a boolean value.

fn read_byte(&mut self, _schema: &Schema<'_>) -> Result<i8, SerdeError>

Reads a byte (i8) value.

fn read_short(&mut self, _schema: &Schema<'_>) -> Result<i16, SerdeError>

Reads a short (i16) value.

fn read_integer(&mut self, _schema: &Schema<'_>) -> Result<i32, SerdeError>

Reads an integer (i32) value.

fn read_long(&mut self, _schema: &Schema<'_>) -> Result<i64, SerdeError>

Reads a long (i64) value.

fn read_float(&mut self, _schema: &Schema<'_>) -> Result<f32, SerdeError>

Reads a float (f32) value.

fn read_double(&mut self, _schema: &Schema<'_>) -> Result<f64, SerdeError>

Reads a double (f64) value.

fn read_big_integer( &mut self, _schema: &Schema<'_>, ) -> Result<BigInteger, SerdeError>

Reads a big integer value.

fn read_big_decimal( &mut self, _schema: &Schema<'_>, ) -> Result<BigDecimal, SerdeError>

Reads a big decimal value.

fn read_string(&mut self, _schema: &Schema<'_>) -> Result<String, SerdeError>

Reads a string value.

fn read_blob(&mut self, _schema: &Schema<'_>) -> Result<Blob, SerdeError>

Reads a blob (byte array) value.

fn read_timestamp( &mut self, _schema: &Schema<'_>, ) -> Result<DateTime, SerdeError>

Reads a timestamp value.

fn read_document( &mut self, _schema: &Schema<'_>, ) -> Result<Document, SerdeError>

Reads a document value.

fn is_null(&self) -> bool

Checks if the current value is null.

fn container_size(&self) -> Option<usize>

Returns the size of the current container if known.

fn read_null(&mut self) -> Result<(), SerdeError>

Consumes a null value, advancing past it.

fn read_string_list( &mut self, schema: &Schema<'_>, ) -> Result<Vec<String>, SerdeError>

Reads a list of strings.

fn read_blob_list( &mut self, schema: &Schema<'_>, ) -> Result<Vec<Blob>, SerdeError>

Reads a list of blobs.

fn read_integer_list( &mut self, schema: &Schema<'_>, ) -> Result<Vec<i32>, SerdeError>

Reads a list of integers.

fn read_long_list( &mut self, schema: &Schema<'_>, ) -> Result<Vec<i64>, SerdeError>

Reads a list of longs.

fn read_string_string_map( &mut self, schema: &Schema<'_>, ) -> Result<HashMap<String, String>, SerdeError>

Reads a map with string values.