Struct SingerSourceConfig 

pub struct SingerSourceConfig {
    pub executable: String,
    pub args: Vec<String>,
    pub tap_config: Value,
    pub catalog: Option<Value>,
    pub stream: String,
    pub state_key: Option<String>,
    pub flush_on_state: bool,
    pub idle_timeout_secs: Option<u64>,
    pub on_malformed: MalformedPolicy,
}

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

Configuration for the Singer tap bridge source.

Runs an external Singer tap executable and adapts its stdout message stream into faucet records. v0 is single-stream only: exactly the stream named by stream is emitted; RECORD messages for other streams are ignored.

Fields

executable: String

The tap executable to run (looked up on PATH, or an absolute path), e.g. tap-github or /opt/taps/tap-csv.

args: Vec<String>

Extra positional/flag arguments appended after faucet’s own --config / --catalog / --state flags.

tap_config: Value

The tap’s configuration object. faucet’s loader has already resolved any ${secret:…} references before this reaches the source; it is materialized to a private temp file and passed as --config.

catalog: Option<Value>

Optional Singer catalog object, passed as --catalog when present. Selects streams/fields; required by most SDK-based taps.

stream: String

The single stream to emit records for. RECORD messages for any other stream are dropped (v0 is single-stream).

state_key: Option<String>

State-store key for the resume bookmark. Defaults to singer:{executable}:{stream} when unset.

flush_on_state: bool

Flush the current page whenever the tap emits a STATE message (so the pipeline can checkpoint at the tap’s own commit points). Default true.

idle_timeout_secs: Option<u64>

Abort the run if no line arrives from the tap within this many seconds. None (default) waits indefinitely.

on_malformed: MalformedPolicy

How to handle a line that is not valid Singer JSON. Default MalformedPolicy::Skip.

Implementations

impl SingerSourceConfig

pub fn new( executable: impl Into<String>, stream: impl Into<String>, ) -> SingerSourceConfig

Convenience constructor for the two required fields; other fields take their serde defaults.

pub fn effective_state_key(&self) -> String

The effective state-store key: the configured state_key, or the derived default singer:{executable}:{stream}.

The derived key is sanitized so a path-style executable (e.g. /opt/taps/tap-csv) still yields a valid state key — validate_state_key only permits [A-Za-z0-9_\-:.], so any other character (notably /) is replaced with _.

Trait Implementations

impl Clone for SingerSourceConfig

fn clone(&self) -> SingerSourceConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SingerSourceConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SingerSourceConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for SingerSourceConfig

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 SingerSourceConfig

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.