Struct Capabilities 

#[non_exhaustive]
pub struct Capabilities { /* private fields */ }

What a connector can do, as declared by the connector itself.

Build one with Capabilities::builder; read it through the accessor methods. Source-side and sink-side fields live in one type so a registry can treat both alike; the fields that do not apply to a role stay at their defaults.

Implementations

impl Capabilities

pub fn builder() -> CapabilitiesBuilder

A builder with every capability off and no write modes.

pub fn to_builder(&self) -> CapabilitiesBuilder

A builder starting from these capabilities, to add or remove one.

pub fn plain_source() -> Self

What a plain source declares: nothing.

pub fn append_only_sink() -> Self

What a plain sink declares: append only.

pub fn of_source<S: Source + ?Sized>(source: &S) -> Self

Derive a source’s capabilities from its per-capability trait methods. The default Source::capabilities; an override that adds a capability no trait method expresses starts here (Capabilities::of_source(self).to_builder().range_digest(true).build()).

pub fn of_sink<S: Sink + ?Sized>(sink: &S) -> Self

Derive a sink’s capabilities from its per-capability trait methods. The default Sink::capabilities.

pub fn decorated_source<S: Source + ?Sized>( outer: &S, inner: &Capabilities, ) -> Self

A decorator’s capabilities: every field a trait method expresses is derived from the decorator (which forwards or deliberately withholds it), the rest is taken from the wrapped source’s inner declaration.

pub fn decorated_sink<S: Sink + ?Sized>(outer: &S, inner: &Capabilities) -> Self

decorated_source for sinks.

pub fn write_modes(&self) -> &[WriteMode]

Write modes the sink applies, in canonical order.

pub fn supports_write_mode(&self, mode: WriteMode) -> bool

Whether the sink applies mode.

pub fn overwrite(&self) -> bool

write_mode: overwrite (atomic full-destination replacement).

pub fn idempotent_writes(&self) -> bool

Commits a page’s rows and a commit token atomically.

pub fn keyed_upsert(&self) -> bool

Converges by key under write_mode: upsert — the keyed-upsert effectively-once mechanism. A sink that forwards key to a target it cannot vouch for accepts upsert without this.

pub fn keyed_dedup(&self) -> bool

This config dedups by key (write_mode: upsert|delete with a key).

pub fn cleanup(&self) -> bool

Scoped cleanup of rows the run did not write (#478).

pub fn rollback(&self) -> bool

Undoing a run it wrote (#706).

pub fn schema_evolution(&self) -> bool

Additive / widening DDL (on_drift: evolve).

pub fn schema_report(&self) -> SchemaReport

How the sink treats fields its destination lacks.

pub fn scoped_overwrite(&self) -> bool

A windowed overwrite.scope (#518).

pub fn direct_overwrite(&self) -> bool

A staging-free overwrite that understands the grouped staging signal.

pub fn staged_load(&self) -> bool

Bulk load through an object-store stage (#528).

pub fn exactly_once(&self) -> bool

Deterministic replay from a bookmark (exactly-once source).

pub fn discover(&self) -> bool

Dataset discovery (faucet discover).

pub fn shardable(&self) -> bool

Splits into shards for clustered execution.

pub fn range_read(&self) -> bool

Reads one integer-key range through apply_shard without shard: config (faucet verify range mode).

pub fn range_digest(&self) -> bool

Computes a server-side digest of a key range (Source::range_digest).

pub fn reports_lag(&self) -> bool

Reports how far behind its head it is (Source::lag).

pub fn columnar(&self) -> bool

Speaks Arrow on the columnar path.

pub fn native(&self) -> bool

Takes part in the native byte-passthrough path.

pub fn table_routing(&self) -> bool

Names the table each record belongs to (Source::record_table), so one change stream can drive a multi-table mirror.

pub fn read_side_effects(&self) -> bool

Reading changes state outside the pipeline — creates or advances a replication slot or capture position, joins a consumer group, opens a listener or a live session — so a read-only preview must not read it.

pub fn replay_guarantee(&self) -> ReplayGuarantee

The source’s typed replay guarantee.

pub fn sink_guarantee(&self) -> SinkGuarantee

The strongest delivery guarantee the sink can uphold.

Trait Implementations

impl Clone for Capabilities

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Capabilities

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

Formats the value using the given formatter.

impl Default for Capabilities

fn default() -> Self

Returns the “default value” for a type.

impl Eq for Capabilities

impl PartialEq for Capabilities

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Capabilities

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Capabilities