Struct IngestionClient 

pub struct IngestionClient { /* private fields */ }

Implementations

impl IngestionClient

pub fn new( args: IngestionClientArgs, metrics: Arc<IngestionMetrics>, ) -> IngestionResult<Self>

Construct a new ingestion client. Its source is determined by args.

pub fn with_store( store: Arc<dyn ObjectStore>, metrics: Arc<IngestionMetrics>, ) -> IngestionResult<Self>

An ingestion client that fetches checkpoints from a remote object store.

pub fn with_grpc( url: Url, username: Option<String>, password: Option<String>, metrics: Arc<IngestionMetrics>, ) -> IngestionResult<Self>

An ingestion client that fetches checkpoints from a fullnode, over gRPC.

pub fn metrics(&self) -> &Arc<IngestionMetrics>

The metrics handle this client reports against. Callers constructing peer services (e.g. an IngestionService) against the same client should reuse this Arc rather than building a second IngestionMetrics from the same registry, which would double-register the metric vectors.

pub fn from_trait( client: Arc<dyn IngestionClientTrait>, metrics: Arc<IngestionMetrics>, ) -> Self

Wrap an arbitrary IngestionClientTrait implementation in an IngestionClient. Use this when the source of checkpoints is not one of the built-in remote object stores or gRPC endpoints — for example, when embedding the indexer in a fullnode that already has checkpoint data on hand.

pub async fn wait_for( &self, checkpoint: u64, retry_interval: Duration, ) -> IngestionResult<CheckpointEnvelope>

Fetch checkpoint data by sequence number.

This function behaves like IngestionClient::fetch, but will repeatedly retry the fetch if the checkpoint is not found, on a constant back-off. The time between fetches is controlled by the retry_interval parameter.

pub async fn checkpoint( &self, cp_sequence_number: u64, ) -> IngestionResult<CheckpointEnvelope>

Fetch checkpoint data by sequence number.

Repeatedly retries transient errors with an exponential backoff (up to MAX_TRANSIENT_RETRY_INTERVAL). Transient errors are defined by the client implementation that returns a CheckpointError::Fetch or CheckpointError::Decode error variant.

The function will immediately return if the checkpoint is not found.

pub async fn latest_checkpoint_number(&self) -> Result<u64>

Trait Implementations

impl Clone for IngestionClient

fn clone(&self) -> IngestionClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.