Struct couch_rs::Client

pub struct Client {
    pub uri: String,
    pub db_prefix: String,
    // some fields omitted
}

Client handles the URI manipulation logic and the HTTP calls to the CouchDB REST API. It is also responsible for the creation/access/destruction of databases.

Fields

uri: String

db_prefix: String

Implementations

impl Client

pub fn new(uri: &str) -> Result<Client, CouchError>

new creates a new Couch client with a default timeout of 5 seconds. The URI has to be in this format: http://hostname:5984, for example: http://192.168.64.5:5984

pub fn new_with_timeout(uri: &str, timeout: u64) -> Result<Client, CouchError>

new_with_timeout creates a new Couch client. The URI has to be in this format: http://hostname:5984, timeout is in seconds.

pub fn get_self(&mut self) -> &mut Self

pub fn set_uri(&mut self, uri: String) -> &Self

pub fn set_prefix(&mut self, prefix: String) -> &Self

pub fn gzip(&mut self, enabled: bool) -> Result<&Self, CouchError>

pub fn timeout(&mut self, to: u64) -> Result<&Self, CouchError>

pub async fn list_dbs<'_>(&'_ self) -> Result<Vec<String>, CouchError>

List the databases in CouchDB

Usage:

use std::error::Error;

const DB_HOST: &str = "http://admin:password@localhost:5984";
const TEST_DB: &str = "test_db";

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let client = couch_rs::Client::new(DB_HOST)?;
    let db = client.db(TEST_DB).await?;
    let dbs = client.list_dbs().await?;
    dbs.iter().for_each(|db| println!("Database: {}", db));
    Ok(())
}

pub async fn db<'_, '_>(
    &'_ self,
    dbname: &'_ str
) -> Result<Database, CouchError>

Connect to an existing database, or create a new one, when this one does not exist.

pub async fn make_db<'_, '_>(
    &'_ self,
    dbname: &'_ str
) -> Result<Database, CouchError>

pub async fn destroy_db<'_, '_>(
    &'_ self,
    dbname: &'_ str
) -> Result<bool, CouchError>

pub async fn check_status<'_>(&'_ self) -> Result<CouchStatus, CouchError>

pub fn req(
    &self,
    method: Method,
    path: String,
    opts: Option<HashMap<String, String>>
) -> Result<RequestBuilder, CouchError>

pub fn get(
    &self,
    path: String,
    args: Option<HashMap<String, String>>
) -> Result<RequestBuilder, CouchError>

pub fn post(
    &self,
    path: String,
    body: String
) -> Result<RequestBuilder, CouchError>

pub fn put(
    &self,
    path: String,
    body: String
) -> Result<RequestBuilder, CouchError>

pub fn head(
    &self,
    path: String,
    args: Option<HashMap<String, String>>
) -> Result<RequestBuilder, CouchError>

pub fn delete(
    &self,
    path: String,
    args: Option<HashMap<String, String>>
) -> Result<RequestBuilder, CouchError>

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.