Struct dynamo_subscriber::client::Client

pub struct Client { /* private fields */ }

Client for both Amazon DynamoDB and Amazon DynamoDB Streams.

A [SdkConfig] is required to construct a client. You can select any ways to get [SdkConfig] and pass it to a client.

For example, if you want to subscribe dynamodb streams from your dynamodb-local running on localhost:8000, set endpoint_url to your [SdkConfig].

use dynamo_subscriber::Client;

let config = aws_config::load_from_env()
    .await
    .into_builder()
    .endpoint_url("http://localhost:8000")
    .build();
let client = Client::new(&config);

See the aws-config docs for more information on customizing configuration.

Implementations

impl Client

pub fn new(config: &SdkConfig) -> Self

Create a new client using passed configuration.

use dynamo_subscriber::Client;

let config = aws_config::load_from_env().await;
let client = Client::new(&config);

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Client

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

Formats the value using the given formatter.

impl DynamodbClient for Client

fn get_stream_arn<'life0, 'async_trait>( &'life0 self, table_name: impl 'async_trait + Into<String> + Send ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Return DynamoDB Stream Arn from DynamoDB TableDescription.

fn get_shards<'life0, 'async_trait>( &'life0 self, stream_arn: impl 'async_trait + Into<String> + Send, exclusive_start_shard_id: Option<String> ) -> Pin<Box<dyn Future<Output = Result<GetShardsOutput, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Return a vector of Shard and shard id for next iteration.

fn get_shard_with_iterator<'life0, 'async_trait>( &'life0 self, stream_arn: impl 'async_trait + Into<String> + Send, shard: Shard, shard_iterator_type: ShardIteratorType ) -> Pin<Box<dyn Future<Output = Result<Shard, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Return a Shard that is the shard passed as an argument with shard iterator id.

fn get_records<'life0, 'async_trait>( &'life0 self, shard: Shard ) -> Pin<Box<dyn Future<Output = Result<GetRecordsOutput, Error>> + Send + 'async_trait>>where Self: 'async_trait, 'life0: 'async_trait,

Return a vector of Record and a Shard with shard iterator id for next getting records call.