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, username: &str, password: &str) -> CouchResult<Client>

new creates a new Couch client with a default timeout of 10 seconds. The timeout is applied from when the request starts connecting until the response body has finished. The URI has to be in this format: http://hostname:5984, for example: http://192.168.64.5:5984

pub fn new_no_auth(uri: &str) -> CouchResult<Client>

new_no_auth creates a new Couch client with a default timeout of 10 seconds. Without authentication. The timeout is applied from when the request starts connecting until the response body has finished. The URI has to be in this format: http://hostname:5984, for example: http://192.168.64.5:5984

pub fn new_local_test() -> CouchResult<Client>

new_local_test creates a new Couch client for testing purposes with a default timeout of 10 seconds. The timeout is applied from when the request starts connecting until the response body has finished. The URI that will be used is: http://hostname:5984, with a username of "admin" and a password of "password". Use this only for testing!!!

pub fn new_with_timeout(
    uri: &str,
    username: Option<&str>,
    password: Option<&str>,
    timeout: u64
) -> CouchResult<Client>

new_with_timeout creates a new Couch client. The URI has to be in this format: http://hostname:5984, The timeout is applied from when the request starts connecting until the response body has finished. 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 async fn list_dbs<'_>(&'_ self) -> CouchResult<Vec<String>>

List the databases in CouchDB

Usage:

use std::error::Error;

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

#[tokio::main]
async fn main() -> Result<(), Box<dyn Error>> {
    let client = couch_rs::Client::new(DB_HOST, DB_USER, DB_PW)?;
    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) -> CouchResult<Database>

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

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

Create a new database with the given name

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

Destroy the database with the given name

pub async fn exists<'_, '_>(&'_ self, dbname: &'_ str) -> CouchResult<bool>

Checks if a database exists

Usage:

use couch_rs::error::CouchResult;

const TEST_DB: &str = "test_db";

#[tokio::main]
async fn main() -> CouchResult<()> {
    let client = couch_rs::Client::new_local_test()?;
    let db = client.db(TEST_DB).await?;

    if db.exists(TEST_DB).await {
        println!("The database exists");
    }

    return Ok(());
}

pub async fn get_info<'_, '_>(&'_ self, dbname: &'_ str) -> CouchResult<DbInfo>

Gets information about the specified database. See common for more details.

pub async fn check_status<'_>(&'_ self) -> CouchResult<CouchStatus>

Returns meta information about the instance. The response contains information about the server, including a welcome message and the version of the server. See common for more details.

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

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.