Struct XmlStream 

pub struct XmlStream { /* private fields */ }

A configured XML API source that handles pagination and extraction.

Implementations

impl XmlStream

pub fn new(config: XmlStreamConfig) -> Self

Create a new XML stream from the given configuration.

pub fn with_auth_provider(self, provider: SharedAuthProvider) -> Self

Attach a shared AuthProvider. When set, the provider supplies the credential for every request (taking precedence over inline auth), so several sources can share one token with single-flight refresh. Used by the CLI to resolve auth: { ref }, and by library callers who construct one provider and inject it into many sources.

pub async fn fetch_all(&self) -> Result<Vec<Value>, FaucetError>

Fetch all records across all pages.

Trait Implementations

impl Source for XmlStream

fn stream_pages<'a>( &'a self, context: &'a HashMap<String, Value>, _batch_size: usize, ) -> Pin<Box<dyn Stream<Item = Result<StreamPage, FaucetError>> + Send + 'a>>

Stream records from the XML response without materialising the whole document tree. The event-driven parser only builds JSON values for elements matching XmlStreamConfig::records_element_path; other elements are observed and discarded, so client-side memory is bounded at O(batch_size * record_size) regardless of how large the document is.

Records are accumulated into a buffer of XmlStreamConfig::batch_size entries and yielded as a StreamPage once the buffer is full. The trailing partial buffer (if any) is emitted after the parser hits EOF and all pagination rounds drain.

The trait-level batch_size argument is intentionally ignored in favour of the config field — the config is the user-facing knob the README documents, and routing the pipeline-supplied hint through it would silently override an explicit config value. batch_size = 0 drains every page into a single emitted page.

Bookmarks are always None — the XML source has no incremental-replication mode today; pagination only walks the API’s own page-number / offset cursor.

fn fetch_with_context<'life0, 'life1, 'async_trait>( &'life0 self, context: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Value>, FaucetError>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Primary fetch method. Receives context from a parent source’s records.

fn config_schema(&self) -> Value

Return a JSON Schema describing the configuration this source accepts.

fn fetch_all<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Value>, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Convenience: fetch with no parent context.

fn fetch_with_context_incremental<'life0, 'life1, 'async_trait>( &'life0 self, context: &'life1 HashMap<String, Value>, ) -> Pin<Box<dyn Future<Output = Result<(Vec<Value>, Option<Value>), FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Incremental fetch with parent context support.

fn fetch_all_incremental<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(Vec<Value>, Option<Value>), FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Convenience: incremental fetch with no parent context.

fn state_key(&self) -> Option<String>

Stable key under which this source’s incremental-replication bookmark should be persisted in a StateStore.

fn apply_start_bookmark<'life0, 'async_trait>( &'life0 self, _bookmark: Value, ) -> Pin<Box<dyn Future<Output = Result<(), FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Apply a bookmark loaded from a StateStore as this run’s starting point.

fn connector_name(&self) -> &'static str

Stable identifier used as the connector label on metrics and the connector attribute on spans. Defaults to the final segment of std::any::type_name::<Self>(), e.g. "RestSource". Built-in connectors override with a short, friendly snake_case name (e.g. "rest"). Must return a non-empty string; observability decorators fall back to "unknown" in release builds if it is empty (and debug_assert! in debug builds).

fn check<'life0, 'life1, 'async_trait>( &'life0 self, ctx: &'life1 CheckContext, ) -> Pin<Box<dyn Future<Output = Result<CheckReport, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Run a fast, non-mutating preflight probe (used by faucet doctor).