Struct XmlStreamConfig 

pub struct XmlStreamConfig {
    pub base_url: String,
    pub path: String,
    pub method: Method,
    pub auth: XmlAuth,
    pub headers: HeaderMap,
    pub body: Option<String>,
    pub records_element_path: Option<String>,
    pub pagination: Option<XmlPagination>,
    pub max_pages: Option<usize>,
    pub query_params: HashMap<String, String>,
}

Configuration for the XML source.

Fields

base_url: String

Base URL of the API.

path: String

Request path (appended to base_url).

method: Method

HTTP method (GET or POST for SOAP).

auth: XmlAuth

Authentication method.

headers: HeaderMap

Additional request headers.

body: Option<String>

Optional request body (e.g. SOAP envelope).

records_element_path: Option<String>

Dot-separated path to the repeating element in the XML response (e.g. "Envelope.Body.GetUsersResponse.Users.User").

pagination: Option<XmlPagination>

Pagination configuration.

max_pages: Option<usize>

Maximum number of pages to fetch.

query_params: HashMap<String, String>

Query parameters to include in every request.

Implementations

impl XmlStreamConfig

pub fn new(base_url: impl Into<String>, path: impl Into<String>) -> Self

Create a new config with required fields.

pub fn method(self, method: Method) -> Self

Set the HTTP method (default: GET).

pub fn auth(self, auth: XmlAuth) -> Self

Set the authentication method.

pub fn headers(self, headers: HeaderMap) -> Self

Set additional headers.

pub fn body(self, body: impl Into<String>) -> Self

Set a SOAP or XML request body.

pub fn records_element_path(self, path: impl Into<String>) -> Self

Set the dot-separated path to the repeating element.

pub fn pagination(self, pagination: XmlPagination) -> Self

Set pagination configuration.

pub fn max_pages(self, max: usize) -> Self

Set the maximum number of pages.

pub fn query_param( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Add a query parameter.

Trait Implementations

impl Clone for XmlStreamConfig

fn clone(&self) -> XmlStreamConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for XmlStreamConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for XmlStreamConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for XmlStreamConfig

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 XmlStreamConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.