Struct HttpBindingProtocol 

pub struct HttpBindingProtocol<C> { /* private fields */ }

An HTTP protocol for REST-style APIs that use HTTP bindings.

This protocol splits input members between HTTP locations (headers, query strings, URI labels) and the payload based on HTTP binding traits (@httpHeader, @httpQuery, @httpLabel, @httpPayload, etc.). Non-bound members are serialized into the body using the provided codec.

Type parameters

• C — the payload codec (e.g., JsonCodec, XmlCodec)

Implementations

impl<C: Codec> HttpBindingProtocol<C>

pub fn new(protocol_id: ShapeId, codec: C, content_type: &'static str) -> Self

Creates a new HTTP binding protocol.

pub fn codec(&self) -> &C

Returns a reference to the body codec. Used by wrapper protocols (e.g. AwsRestXmlProtocol) that need to construct and pre-configure a body serializer before delegating to serialize_request_with_body.

pub fn serialize_request_with_body( &self, body: <C as Codec>::Serializer, input: &dyn SerializableStruct, input_schema: &Schema, endpoint: &str, cfg: &ConfigBag, ) -> Result<Request, SerdeError>

Body-providable variant of serialize_request. The caller supplies an already-constructed body serializer, allowing codec-specific pre-configuration (e.g. setting one-shot state on the body codec before binding-driven serialization begins). The default serialize_request implementation calls this with a fresh serializer from the codec.

This is the extension point used by AwsRestXmlProtocol to inject the member-level @xmlName for an @httpPayload struct member into the body codec — a value the codec couldn’t otherwise see because codegen passes the target shape’s SCHEMA for that member, which carries the target’s @xmlName but not the member’s.

Trait Implementations

impl<C> ClientProtocolInner for HttpBindingProtocol<C>

where C: Codec + Send + Sync + Debug + 'static, for<'a> C::Deserializer<'a>: ShapeDeserializer,

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<C: Debug> Debug for HttpBindingProtocol<C>

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

Formats the value using the given formatter.