Crate rqlite_rs

An async rqlite client for Rust.

Have a look at the README to get started or browse the examples.

The simplest way to get started is importing the prelude and creating a client via the RqliteClientBuilder:

use rqlite_rs::prelude::*;

#[derive(FromRow)]
pub struct Table {
    name: String,
}

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let client = RqliteClientBuilder::new()
        .known_host("localhost:4001")
        .build()?;

    let query = rqlite_rs::query!(
        "SELECT name FROM sqlite_master WHERE type='table' AND name NOT LIKE 'sqlite_%'"
    )?;

    let rows = client.fetch(query).await?;

    let tables = rows.into_typed::<Table>()?;

    for table in tables {
        println!("Table: {}", table.name);
    }

    Ok(())
}

This will print all tables in the rqlite database.

Features

The following features are available and out of these macros and native-tls are enabled by default:

• macros: Use the FromRow derive macro to automatically convert rows to structs.
• fast-blob: When enabled, the client will use base64 encoding for retrieving blobs, reducing the amount of data transferred.
• random-fallback: This allows using a random known host as fallback when the primary host is unreachable. This is behind a feature flag because it requires an additional dependency.
• native-tls: Use the reqwest native-tls backend for TLS connections.
• rustls-tls: Use the reqwest rustls-tls backend for TLS connections.

Re-exports

pub use client::RqliteClient;

pub use client::RqliteClientBuilder;

Modules

batch

client

config

decode

error

fallback

node

prelude

query

query_result

request

response

Macros

arg

query

A macro for creating a query. Returns a Result with an RqliteQuery if the query is valid. The macro accepts a query string and optional arguments.

Structs

Column

Row

Enums

IntoTypedError

Traits

FromRow

IntoTypedRows

Derive Macros

FromRow

Derives the FromRow trait for a struct.