Struct HttpAdapter 

pub struct HttpAdapter { /* private fields */ }

HTTP adapter that talks to a remote CouchDB instance.

Implementations

impl HttpAdapter

pub fn new(url: &str) -> Self

Create a new HTTP adapter pointing at a CouchDB database URL.

The URL should include the database name, e.g. http://localhost:5984/mydb or http://admin:password@localhost:5984/mydb

pub fn with_client(url: &str, client: Client) -> Self

Create a new HTTP adapter with a custom reqwest client.

pub fn with_auth_client(url: &str, auth: &AuthClient) -> Self

Create a new HTTP adapter using an authenticated client.

The AuthClient must have been logged in already; its internal reqwest client (with cookie store) will be shared with this adapter.

Trait Implementations

impl Adapter for HttpAdapter

fn info<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DbInfo>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get database information: name, document count, update sequence.

fn get<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, opts: GetOptions, ) -> Pin<Box<dyn Future<Output = Result<Document>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a single document by ID.

fn bulk_docs<'life0, 'async_trait>( &'life0 self, docs: Vec<Document>, opts: BulkDocsOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<DocResult>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Write multiple documents atomically.

fn all_docs<'life0, 'async_trait>( &'life0 self, opts: AllDocsOptions, ) -> Pin<Box<dyn Future<Output = Result<AllDocsResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Query all documents, optionally filtered by key range.

fn changes<'life0, 'async_trait>( &'life0 self, opts: ChangesOptions, ) -> Pin<Box<dyn Future<Output = Result<ChangesResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get changes since a given sequence number.

fn revs_diff<'life0, 'async_trait>( &'life0 self, revs: HashMap<String, Vec<String>>, ) -> Pin<Box<dyn Future<Output = Result<RevsDiffResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Compare sets of document revisions to find which ones the adapter is missing. Used during replication to avoid transferring data the target already has.

fn bulk_get<'life0, 'async_trait>( &'life0 self, docs: Vec<BulkGetItem>, ) -> Pin<Box<dyn Future<Output = Result<BulkGetResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Fetch multiple documents by ID and revision in a single request. Used during replication to efficiently retrieve missing documents.

fn put_attachment<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, doc_id: &'life1 str, att_id: &'life2 str, rev: &'life3 str, data: Vec<u8>, content_type: &'life4 str, ) -> Pin<Box<dyn Future<Output = Result<DocResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Store an attachment on a document.

fn get_attachment<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, doc_id: &'life1 str, att_id: &'life2 str, opts: GetAttachmentOptions, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Retrieve raw attachment data.

fn remove_attachment<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, doc_id: &'life1 str, att_id: &'life2 str, rev: &'life3 str, ) -> Pin<Box<dyn Future<Output = Result<DocResult>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Remove an attachment from a document.

fn get_local<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Value>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a local document (not replicated, used for checkpoints).

fn put_local<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, doc: Value, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Write a local document (not replicated, used for checkpoints).

fn remove_local<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a local document.

fn compact<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Compact the database: remove old revisions, clean up unreferenced attachment data.

fn destroy<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Destroy the database and all its data.

fn purge<'life0, 'async_trait>( &'life0 self, req: HashMap<String, Vec<String>>, ) -> Pin<Box<dyn Future<Output = Result<PurgeResponse>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Purge (permanently remove) document revisions.

fn get_security<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SecurityDocument>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the security document for this database.

fn put_security<'life0, 'async_trait>( &'life0 self, doc: SecurityDocument, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Set the security document for this database.

fn close<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), RouchError>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Close the database, releasing any held resources. Default implementation is a no-op.