Struct DatagenSource 

pub struct DatagenSource { /* private fields */ }

Synthetic storefront-event source. See the crate docs for the dataset, the referential-integrity mechanism, and what this source deliberately does not promise.

Implementations

impl DatagenSource

pub fn new(config: DatagenSourceConfig) -> DatagenSource

A source over config.

pub fn from_component_config( section: &ComponentConfig, ) -> Result<DatagenSource, ConfigError>

Build from the pipeline’s opaque source: { datagen: ... } section.

pub fn avro_schema() -> &'static str

The Avro schema the avro encoding writes against, as JSON. The same string as EVENT_SCHEMA_JSON.

pub fn committed(&self) -> &BTreeMap<PartitionId, i64>

Every watermark this source has been asked to commit. In memory, and nowhere else; see the crate docs.

Trait Implementations

impl Debug for DatagenSource

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

Formats the value using the given formatter.

impl Source for DatagenSource

type Lane = DatagenLane

The lane type this source produces.

fn component_type(&self) -> &str

The component_type metric label for this source (e.g. "kafka"), mirroring SinkParts::with_component_type on the sink side. It is also the namespace of the source’s custom-metrics Meter: declaring "kafka" scopes the source’s own families under spate_kafka_source_*. The default "source" is a reserved root, so a source that does not override this gets no custom Meter (its framework stage metrics are unaffected).

fn framing_contract(&self) -> FramingContract

How the payloads this source emits are framed, so the framework can pair it with a deserializer without the two being coordinated by hand (see FramingContract). A source that splits its own bytes into one record per payload returns FramingContract::PerRecord; the default is FramingContract::WholePayload, where the source emits whole payloads and the deserializer owns framing (Kafka, and any source that does not frame).

fn open(&mut self, ctx: SourceCtx) -> Result<(), SourceError>

Connect and prepare. Called once before any other method.

fn poll_events( &mut self, timeout: Duration, ) -> Result<SourceEvent<DatagenLane>, SourceError>

Service control-plane work (rebalance callbacks, statistics) and return the next event, waiting at most timeout. Must be called regularly regardless of backpressure state.

fn commit( &mut self, watermarks: &[(PartitionId, i64)], ) -> Result<(), SourceError>

Store per-partition committable positions (each is the offset one past the last acknowledged record). Positions are durable per the source’s own policy (e.g. interval auto-commit of stored offsets).

fn pause(&mut self, lanes: &[LaneId]) -> Result<(), SourceError>

Stop fetching for lanes (backpressure). Optional capability: sources that cannot pause rely on bounded-queue pushback alone.

fn resume(&mut self, lanes: &[LaneId]) -> Result<(), SourceError>

Resume fetching for lanes.

fn flush_commits(&mut self) -> Result<(), SourceError>

Synchronously flush stored positions (shutdown, revocation).