Struct AwsRestXmlProtocol 

pub struct AwsRestXmlProtocol { /* private fields */ }

AWS REST XML protocol (aws.protocols#restXml).

Implementations

impl AwsRestXmlProtocol

pub fn new() -> Self

Construct a new AwsRestXmlProtocol with default settings: Content-Type application/xml, date-time default timestamp format, error envelopes wrapped in <ErrorResponse> (i.e. noErrorWrapping = false), and no service-level @xmlNamespace.

Use Self::with_no_error_wrapping to opt in to the noErrorWrapping variant of the @restXml trait, and Self::with_service_xml_namespace to set a service-level default xmlns. Both methods are typically called by code generation based on the service shape’s traits; manual construction is fine for tests or custom protocols.

pub fn with_no_error_wrapping(self, v: bool) -> Self

Configure whether error responses use the noErrorWrapping variant of the @restXml trait. When true, error response bodies have <Error> as the document root; when false (default), they are wrapped in <ErrorResponse><Error>...</Error>...</ErrorResponse>. Drives the parsing branch in Self::deserialize_error_response.

pub fn no_error_wrapping(&self) -> bool

Returns the current noErrorWrapping setting. See Self::with_no_error_wrapping for semantics.

pub fn with_service_xml_namespace( self, uri: impl Into<String>, prefix: Option<String>, ) -> Self

Configures the service-level @xmlNamespace declared on the Smithy service shape. Applied to request/response XML root elements that don’t carry their own @xmlNamespace (e.g. S3’s http://s3.amazonaws.com/doc/2006-03-01/).

pub fn deserialize_error_response<'a>( &self, body: &'a [u8], ) -> Result<(ErrorMetadataBuilder, Box<dyn ShapeDeserializer + 'a>), SerdeError>

Parses a REST XML error response envelope, extracting error metadata (Code, Message, Type, RequestId) and returning a deserializer positioned inside <Error> for per-error-shape member parsing.

Trait Implementations

impl ClientProtocolInner for AwsRestXmlProtocol

type Request = Request

The protocol’s request message type (e.g., http::Request).

type Response = Response

The protocol’s response message type (e.g., http::Response).

fn protocol_id(&self) -> &ShapeId

Returns the Smithy shape ID of this protocol.

fn serialize_request( &self, input: &dyn SerializableStruct, input_schema: &Schema, endpoint: &str, cfg: &ConfigBag, ) -> Result<Request, SerdeError>

Serializes an operation input into a request message.

fn deserialize_response<'a>( &self, response: &'a Response, output_schema: &Schema, cfg: &ConfigBag, ) -> Result<Box<dyn ShapeDeserializer + 'a>, SerdeError>

Deserializes a response message, returning a boxed [ShapeDeserializer] over the response body.

fn payload_codec(&self) -> Option<&dyn DynCodec>

Returns the codec used for payload (de)serialization, if any.

fn update_endpoint( &self, request: &mut Request, endpoint: &Endpoint, cfg: &ConfigBag, ) -> Result<(), SerdeError>

Updates a previously serialized request with a resolved endpoint.

impl Debug for AwsRestXmlProtocol

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

Formats the value using the given formatter.

impl Default for AwsRestXmlProtocol

fn default() -> Self

Returns the “default value” for a type.