Skip to main content

BackendConfig

Enum BackendConfig 

Source
pub enum BackendConfig {
    Redb {
        path: String,
    },
    InMemory,
}
Expand description

Configuration for selecting and building a backend.

This enum provides a unified way to configure different storage backends. Each variant contains the necessary configuration for its respective backend.

§Example

use index::BackendConfig;

// In-memory (for testing)
let config = BackendConfig::in_memory();

// Redb (pure Rust, recommended)
let config = BackendConfig::redb("/data/ucfp.redb");

Variants§

§

Redb

Use Redb for storage. The path is the file path for the database.

Redb is a pure Rust embedded database that doesn’t require C++ dependencies. This is the recommended backend for most deployments.

Requires the backend-redb feature to be enabled at compile time (enabled by default).

Fields

§path: String
§

InMemory

Use an in-memory HashMap for storage. This is useful for testing.

Implementations§

Source§

impl BackendConfig

Source

pub fn in_memory() -> Self

Create an in-memory backend configuration.

Source

pub fn redb<P: Into<String>>(path: P) -> Self

Create a Redb backend configuration.

§Arguments
  • path - The file path where the database will be stored
§Example
use index::BackendConfig;

let config = BackendConfig::redb("/data/ucfp.redb");
Source

pub fn build(&self) -> Result<Box<dyn IndexBackend>, IndexError>

Build the backend based on the configuration.

This method creates the appropriate backend implementation based on the configuration variant. Each backend type is only available if its corresponding feature flag is enabled at compile time.

§Returns
  • Ok(Box<dyn IndexBackend>) - Successfully created backend
  • Err(IndexError) - Failed to create backend or feature not enabled

Trait Implementations§

Source§

impl Clone for BackendConfig

Source§

fn clone(&self) -> BackendConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BackendConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BackendConfig

Source§

fn default() -> BackendConfig

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V