Struct Client 

pub struct Client<T = HttpTransport> { /* private fields */ }

Configured client used to open Circle-backed SQLite databases.

Implementations

impl Client<HttpTransport>

pub fn from_default_config() -> Result<Self>

Load the default local config and construct a client with the HTTP transport.

This is fallible because it reads the configured octra-sqlite config file. Use Client::with_options when construction should be purely in-memory.

Examples found in repository

examples/remilia-read-api/main.rs (line 15)

fn main() -> AppResult<()> {
    let addr = env::var("OCTRA_SQLITE_API_ADDR").unwrap_or_else(|_| "127.0.0.1:8787".to_string());
    let database_name = env::var("OCTRA_SQLITE_DATABASE").unwrap_or_else(|_| "remilia".to_string());
    let client = Client::from_default_config()?;
    let database = client.database(database_name.clone())?;
    let listener = TcpListener::bind(&addr)?;

    eprintln!("listening on http://{addr}");
    eprintln!("try: curl http://{addr}/collections/milady");

    for stream in listener.incoming() {
        match stream {
            Ok(stream) => {
                if let Err(error) = handle_connection(stream, &database, &database_name) {
                    eprintln!("request error: {error}");
                }
            }
            Err(error) => eprintln!("accept error: {error}"),
        }
    }

    Ok(())
}

pub fn with_options(options: ClientOptions) -> Self

Construct a client from explicit options using the default HTTP transport.

impl<T: Transport> Client<T>

pub fn with_transport(options: ClientOptions, transport: T) -> Self

Construct a client from explicit options and a custom transport.

pub fn database(&self, target: impl Into<String>) -> Result<Database<T>>

Open a database by saved name, Circle ID, or oct:// URI.

Examples found in repository

examples/remilia-read-api/main.rs (line 16)

fn main() -> AppResult<()> {
    let addr = env::var("OCTRA_SQLITE_API_ADDR").unwrap_or_else(|_| "127.0.0.1:8787".to_string());
    let database_name = env::var("OCTRA_SQLITE_DATABASE").unwrap_or_else(|_| "remilia".to_string());
    let client = Client::from_default_config()?;
    let database = client.database(database_name.clone())?;
    let listener = TcpListener::bind(&addr)?;

    eprintln!("listening on http://{addr}");
    eprintln!("try: curl http://{addr}/collections/milady");

    for stream in listener.incoming() {
        match stream {
            Ok(stream) => {
                if let Err(error) = handle_connection(stream, &database, &database_name) {
                    eprintln!("request error: {error}");
                }
            }
            Err(error) => eprintln!("accept error: {error}"),
        }
    }

    Ok(())
}

Trait Implementations

impl<T: Clone> Clone for Client<T>

fn clone(&self) -> Client<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for Client<HttpTransport>

Available on crate feature http only.

fn default() -> Self

Returns the “default value” for a type.