Struct Redb

pub struct Redb { /* private fields */ }

Available on crate feature services-redb only.

Redb service support.

Capabilities

This service can be used to:

• stat
• read
• write
• create_dir
• delete
• copy
• rename
• list
• presign
• blocking

Configuration

• datadir: Set the path to the redb data directory.
• table: Set the table name for Redb.

You can refer to RedbBuilder’s docs for more information.

Example

Via Builder

use anyhow::Result;
use opendal::services::Redb;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    let mut builder = Redb::default()
        .datadir("/tmp/opendal/redb")
        .table("opendal-redb");

    let op: Operator = Operator::new(builder)?.finish();
    Ok(())
}

Implementations

impl RedbBuilder

pub fn database(self, db: Arc<Database>) -> Self

Set the database for Redb.

This method should be called when you want to use multiple tables of one database because Redb doesn’t allow opening a database that have been opened.

datadir and database should not be set simultaneously. If both are set, database will take precedence.

pub fn datadir(self, path: &str) -> Self

Set the path to the redb data directory. Will create if not exists.

Opening redb database via datadir takes away the ability to access multiple redb tables. If you need to access multiple redb tables, the correct solution is to create an Arc<redb::database> beforehand and then share it via database with multiple builders where every builder will open one redb table.

pub fn table(self, table: &str) -> Self

Set the table name for Redb. Will create if not exists.

pub fn root(self, path: &str) -> Self

Set the root for Redb.

Trait Implementations

impl Builder for RedbBuilder

const SCHEME: Scheme = Scheme::Redb

Associated scheme for this builder. It indicates what underlying service is.

type Config = RedbConfig

Associated configuration for this builder.

fn build(self) -> Result<impl Access>

Consume the accessor builder to build a service.

impl Debug for RedbBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for RedbBuilder

fn default() -> RedbBuilder

Returns the “default value” for a type.