Skip to main content

SoapConfig

Struct SoapConfig 

Source
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,
}
Expand description

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§

Source§

impl SoapConfig

Source

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.

Source

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.

Source

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§

Source§

impl Clone for SoapConfig

Source§

fn clone(&self) -> SoapConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SoapConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SoapConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

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

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl JsonSchema for SoapConfig

Source§

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

The name of the generated JSON Schema. Read more
Source§

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

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

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

Generates a JSON Schema for this type. Read more
Source§

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. Read more
Source§

impl Serialize for SoapConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more