Struct CorrosionClient 

pub struct CorrosionClient { /* private fields */ }

Convenience client that combines a CorrosionApiClient with a local SQLite connection pool.

Implementations

impl CorrosionClient

pub fn new<P: AsRef<Path>>( api_addr: SocketAddr, db_path: P, ) -> Result<Self, Error>

pub fn with_sqlite_pool( api_addr: SocketAddr, pool: RusqlitePool, ) -> Result<Self, Error>

pub fn pool(&self) -> &RusqlitePool

Borrow the SQLite connection pool used for direct reads.

Methods from Deref<Target = CorrosionApiClient>

pub async fn query_typed<T: DeserializeOwned + Unpin>( &self, statement: &Statement, timeout: Option<u64>, ) -> Result<QueryStream<T>, Error>

Execute a single query against a Corrosion node, deserializing each row into T. Optionally accepts a timeout for the request.

Calls the /v1/queries endpoint (https://superfly.github.io/corrosion/api/queries.html).

pub async fn query( &self, statement: &Statement, timeout: Option<u64>, ) -> Result<QueryStream<Vec<SqliteValue>>, Error>

Same as Self::query_typed, but returns each row as a Vec<SqliteValue>.

pub async fn subscribe_typed<T: DeserializeOwned + Unpin>( &self, statement: &Statement, skip_rows: bool, from: Option<ChangeId>, ) -> Result<SubscriptionStream<T>, Error>

Create a new subscription and stream query updates, deserializing rows into T.

• skip_rows — when true, the initial rows are skipped and only changes are streamed.
• from — when set, resume the subscription past the given ChangeId instead of producing a fresh snapshot.

Calls the /v1/subscriptions endpoint (https://superfly.github.io/corrosion/api/subscriptions.html).

pub async fn subscribe( &self, statement: &Statement, skip_rows: bool, from: Option<ChangeId>, ) -> Result<SubscriptionStream<Vec<SqliteValue>>, Error>

Same as Self::subscribe_typed, but returns each row as a Vec<SqliteValue>.

pub async fn subscription_typed<T: DeserializeOwned + Unpin>( &self, id: Uuid, skip_rows: bool, from: Option<ChangeId>, ) -> Result<SubscriptionStream<T>, Error>

Reconnect to an existing subscription identified by its Uuid.

pub async fn subscription( &self, id: Uuid, skip_rows: bool, from: Option<ChangeId>, ) -> Result<SubscriptionStream<Vec<SqliteValue>>, Error>

Same as Self::subscription_typed, but returns each row as a Vec<SqliteValue>.

pub async fn updates_typed<T: DeserializeOwned + Unpin>( &self, table: &str, ) -> Result<UpdatesStream<T>, Error>

Subscribe to row-level changes on a single table.

Calls the /v1/updates/{table} endpoint (https://superfly.github.io/corrosion/api/updates.html).

pub async fn updates( &self, table: &str, ) -> Result<UpdatesStream<Vec<SqliteValue>>, Error>

Same as Self::updates_typed, but returns each row as a Vec<SqliteValue>.

pub async fn execute( &self, statements: &[Statement], timeout: Option<u64>, ) -> Result<ExecResponse, Error>

Execute one or more SQL statements in a single transaction.

Calls the /v1/transactions endpoint (https://superfly.github.io/corrosion/api/transactions.html).

Trait Implementations

impl Clone for CorrosionClient

fn clone(&self) -> CorrosionClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for CorrosionClient

type Target = CorrosionApiClient

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.