Struct DocumentShapeSerializer 

pub struct DocumentShapeSerializer { /* private fields */ }

Builds a [DiscriminatedDocument] from a typed shape via the ShapeSerializer interface.

See the module-level documentation for an overview.

Discriminator capture

Top-level discriminator capture (e.g. via DiscriminatedDocument::from_struct or via direct calls like ser.write_struct(&MY_SCHEMA, ...)) goes through the inherent DocumentShapeSerializer::write_struct method, which captures the schema’s shape ID into the serializer’s root_discriminator slot.

Nested discriminator capture (a struct member that is itself a struct, called through value.serialize_members(&mut dyn ShapeSerializer)) is not preserved, because [Document] has no per-node discriminator slot — only the outer [DiscriminatedDocument] wrapper carries one. Discriminators apply at the wrapper level, not at every nested struct.

Example

Use DiscriminatedDocument::from_struct for the common case of converting a SerializableStruct into a [DiscriminatedDocument]:

use aws_smithy_schema::document::DiscriminatedDocumentExt;
use aws_smithy_types::DiscriminatedDocument;

let doc = DiscriminatedDocument::from_struct(MyStruct::SCHEMA, &my_struct)?;

Direct construction is useful when round-tripping pieces of a tree outside the standard entry point:

use aws_smithy_schema::document::DocumentShapeSerializer;
use aws_smithy_schema::serde::ShapeSerializer;

let mut ser = DocumentShapeSerializer::new();
ser.write_string(&aws_smithy_schema::prelude::STRING, "hello")?;
let doc = ser.finish()?;

Implementations

impl DocumentShapeSerializer

pub fn new() -> Self

Creates a fresh serializer with an empty frame stack.

pub fn finish(self) -> Result<DiscriminatedDocument, SerdeError>

Consumes the serializer and returns the constructed [DiscriminatedDocument].

The wrapper carries the captured top-level discriminator (the FQN of the schema passed to the inherent DocumentShapeSerializer::write_struct entry point), if any. Settings are not attached — serialize-side documents have no protocol context.

Returns an error if no value has been written yet, if any frame is still open (caller forgot a closing callback), or if the serializer was driven into a malformed state.

pub fn write_struct( &mut self, schema: &Schema<'_>, value: &dyn SerializableStruct, ) -> Result<(), SerdeError>

Inherent struct write that captures the schema’s shape ID as the serializer’s top-level discriminator.

Method resolution prefers this inherent method over the ShapeSerializer::write_struct trait method when the receiver is a concrete &mut DocumentShapeSerializer — so call sites like

let mut ser = DocumentShapeSerializer::new();
ser.write_struct(&MY_SCHEMA, &my_value)?;

hit this method. Indirect calls through &mut dyn ShapeSerializer (e.g., from inside another struct’s serialize_members callback) take the trait method instead, which doesn’t capture a discriminator — nested struct discriminators are deliberately not preserved (see the type-level docs).

Trait Implementations

impl Debug for DocumentShapeSerializer

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

Formats the value using the given formatter.

impl Default for DocumentShapeSerializer

fn default() -> DocumentShapeSerializer

Returns the “default value” for a type.

impl ShapeSerializer for DocumentShapeSerializer

fn write_struct( &mut self, schema: &Schema<'_>, value: &dyn SerializableStruct, ) -> Result<(), SerdeError>

Writes a structure to the serializer.

fn write_list( &mut self, schema: &Schema<'_>, write_elements: &dyn Fn(&mut dyn ShapeSerializer) -> Result<(), SerdeError>, ) -> Result<(), SerdeError>

Writes a list to the serializer.

fn write_map( &mut self, schema: &Schema<'_>, write_entries: &dyn Fn(&mut dyn ShapeSerializer) -> Result<(), SerdeError>, ) -> Result<(), SerdeError>

Writes a map to the serializer.

fn write_boolean( &mut self, schema: &Schema<'_>, value: bool, ) -> Result<(), SerdeError>

Writes a boolean value.

fn write_byte( &mut self, schema: &Schema<'_>, value: i8, ) -> Result<(), SerdeError>

Writes a byte (i8) value.

fn write_short( &mut self, schema: &Schema<'_>, value: i16, ) -> Result<(), SerdeError>

Writes a short (i16) value.

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

Writes an integer (i32) value.

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

Writes a long (i64) value.

fn write_float( &mut self, schema: &Schema<'_>, value: f32, ) -> Result<(), SerdeError>

Writes a float (f32) value.

fn write_double( &mut self, schema: &Schema<'_>, value: f64, ) -> Result<(), SerdeError>

Writes a double (f64) value.

fn write_big_integer( &mut self, schema: &Schema<'_>, value: &BigInteger, ) -> Result<(), SerdeError>

Writes a big integer value.

fn write_big_decimal( &mut self, schema: &Schema<'_>, value: &BigDecimal, ) -> Result<(), SerdeError>

Writes a big decimal value.

fn write_string( &mut self, schema: &Schema<'_>, value: &str, ) -> Result<(), SerdeError>

Writes a string value.

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

Writes a blob (byte array) value.

fn write_timestamp( &mut self, schema: &Schema<'_>, value: &DateTime, ) -> Result<(), SerdeError>

Writes a timestamp value.

fn write_document( &mut self, schema: &Schema<'_>, value: &Document, ) -> Result<(), SerdeError>

Writes a document value.

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

Writes a null value (for sparse collections).

fn write_list_with_length( &mut self, schema: &Schema<'_>, length: usize, write_elements: &dyn Fn(&mut dyn ShapeSerializer) -> Result<(), SerdeError>, ) -> Result<(), SerdeError>

Writes a list with a known number of elements, including sparse nulls.

fn write_map_with_length( &mut self, schema: &Schema<'_>, length: usize, write_entries: &dyn Fn(&mut dyn ShapeSerializer) -> Result<(), SerdeError>, ) -> Result<(), SerdeError>

Writes a map with a known number of entries, including sparse null values.

fn write_string_list( &mut self, schema: &Schema<'_>, values: &[String], ) -> Result<(), SerdeError>

Writes a list of strings.

fn write_blob_list( &mut self, schema: &Schema<'_>, values: &[Blob], ) -> Result<(), SerdeError>

Writes a list of blobs.

fn write_integer_list( &mut self, schema: &Schema<'_>, values: &[i32], ) -> Result<(), SerdeError>

Writes a list of integers.

fn write_long_list( &mut self, schema: &Schema<'_>, values: &[i64], ) -> Result<(), SerdeError>

Writes a list of longs.

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

Writes a map with string keys and string values.