Struct GrpcStream 

pub struct GrpcStream { /* private fields */ }

A configured gRPC source that uses protobuf reflection to call any gRPC method and return JSON records.

Implementations

impl GrpcStream

pub fn new(config: GrpcStreamConfig) -> Result<Self, FaucetError>

Create a new gRPC stream. Loads the FileDescriptorSet from disk.

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 by calling the configured gRPC method.

Trait Implementations

impl Source for GrpcStream

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 page-by-page.

For RpcKind::Unary this falls back to the default trait impl (buffer the full response, then chunk in memory) — see the README’s “Streaming and batching” section for the rationale.

For RpcKind::ServerStreaming this opens the gRPC stream and flushes a page each time the buffer hits config.batch_size (batch_size = 0 drains the entire stream before yielding). The trait-level batch_size argument is ignored in favour of the config field so a pipeline-supplied hint cannot silently override an explicit config value. Transient stream errors reconnect with exponential backoff up to reconnect_max_attempts, unless terminate_on_error = true in which case the run terminates. Server-streaming pages carry bookmark: None — this source has no native cursor/offset, so resumption is driven by user-supplied request fields (e.g. an event id), not a faucet-managed bookmark.

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).