Struct SoapConfig 

pub struct SoapConfig {
    pub version: SoapVersion,
    pub action: Option<String>,
    pub body_inner: Option<String>,
    pub namespaces: HashMap<String, String>,
    pub path_relative_to_body: bool,
    pub fault_as_error: bool,
}

Available on crate features source-rest and source-xml only.

First-class SOAP ergonomics for the XML source.

This is sugar over the existing XML-over-HTTP request/response path — not a WSDL client. When present, the source assembles a SOAP envelope for the request body, injects the version-appropriate headers, and (by default) resolves XmlStreamConfig::records_element_path relative to Envelope.Body and surfaces SOAP <Fault> responses as errors.

Fields

version: SoapVersion

SOAP protocol version (default 1.1).

action: Option<String>

The SOAP action. For 1.1 it becomes the SOAPAction header; for 1.2 it is carried as the action parameter of the Content-Type header. Optional — omit for actionless operations.

body_inner: Option<String>

The XML fragment placed inside <soap:Body> — typically the operation element, e.g. <GetUsers xmlns="urn:example"/>. Mutually exclusive with the top-level XmlStreamConfig::body.

namespaces: HashMap<String, String>

Extra namespace declarations (prefix → URI) added to the envelope element. The soap prefix is reserved for the envelope namespace and any entry using it is ignored.

path_relative_to_body: bool

When true (default), XmlStreamConfig::records_element_path is resolved relative to Envelope.Body — i.e. Envelope.Body. is auto-prepended, so you write GetUsersResponse.Users.User. Set false to supply the fully-qualified path from the document root.

fault_as_error: bool

When true (default), a SOAP <Fault> in the response raises FaucetError::Source. When false, a fault yields zero records (logged once).

Implementations

impl SoapConfig

pub fn build_envelope(&self, body_inner: &str) -> String

Assemble the SOAP request envelope wrapping body_inner inside <soap:Body>, declaring the version namespace plus any user-declared prefixes on the envelope element.

Prefixes are emitted in a deterministic (sorted) order so the assembled body is stable across runs.

pub fn content_type(&self) -> String

The Content-Type header value for a request of this SOAP version.

For 1.2 the action (when set) is carried as a Content-Type parameter.

pub fn soap_action_header(&self) -> Option<String>

The SOAPAction header value (quoted) for SOAP 1.1. Always None for SOAP 1.2, which carries the action inside Content-Type instead.

Trait Implementations

impl Clone for SoapConfig

fn clone(&self) -> SoapConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SoapConfig

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

Formats the value using the given formatter.

impl Default for SoapConfig

fn default() -> SoapConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SoapConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<SoapConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SoapConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for SoapConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.