Struct nebari::Config

source · [−]

pub struct Config<M: FileManager = StdFileManager> { /* private fields */ }

Expand description

A database configuration used to open a database.

Implementations

source

impl Config<StdFileManager>

source

pub fn new<P: AsRef<Path>>(path: P) -> Self

Creates a new config to open a database located at path.

source

pub fn default_for<P: AsRef<Path>>(path: P) -> Self

Returns a default configuration to open a database located at path.

source

pub fn file_manager<M: FileManager>(self, file_manager: M) -> Config<M>

Sets the file manager.

Panics

Panics if called after a shared thread pool has been set.

source

impl<M: FileManager> Config<M>

source

pub fn vault<V: AnyVault>(self, vault: V) -> Self

Sets the vault to use for this database.

source

pub fn cache(self, cache: ChunkCache) -> Self

Sets the chunk cache to use for this database.

source

pub fn shared_thread_pool(self, thread_pool: &ThreadPool<M::File>) -> Self

Uses the thread_pool provided instead of creating its own. This will allow a single thread pool to manage multiple Roots instances’ transactions.

source

pub fn open(self) -> Result<Roots<M::File>, Error>

Opens the database, or creates one if the target path doesn’t exist.

Trait Implementations

source

impl<M: FileManager> Clone for Config<M>

source

fn clone(&self) -> Self

Returns a copy 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<M: Debug + FileManager> Debug for Config<M> where
M::File: Debug,

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<M = StdFileManager> !RefUnwindSafe for Config<M>

impl<M> Send for Config<M>

impl<M> Sync for Config<M>

impl<M> Unpin for Config<M> where
M: Unpin,

impl<M = StdFileManager> !UnwindSafe for Config<M>

Blanket Implementations

source

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

source

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

source

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

source

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

const: unstable · source

pub 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> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

pub fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct nebari::Config

Implementations

impl Config<StdFileManager>

pub fn new<P: AsRef<Path>>(path: P) -> Self

pub fn default_for<P: AsRef<Path>>(path: P) -> Self

pub fn file_manager<M: FileManager>(self, file_manager: M) -> Config<M>

Panics

impl<M: FileManager> Config<M>

pub fn vault<V: AnyVault>(self, vault: V) -> Self

pub fn cache(self, cache: ChunkCache) -> Self

pub fn shared_thread_pool(self, thread_pool: &ThreadPool<M::File>) -> Self

pub fn open(self) -> Result<Roots<M::File>, Error>

Trait Implementations

impl<M: FileManager> Clone for Config<M>

fn clone(&self) -> Self

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

impl<M: Debug + FileManager> Debug for Config<M> where M::File: Debug,

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

Auto Trait Implementations

impl<M = StdFileManager> !RefUnwindSafe for Config<M>

impl<M> Send for Config<M>

impl<M> Sync for Config<M>

impl<M> Unpin for Config<M> where M: Unpin,

impl<M = StdFileManager> !UnwindSafe for Config<M>

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

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

pub fn into(self) -> U

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

type Owned = T

pub fn to_owned(&self) -> T

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

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

type Error = Infallible

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

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

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

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

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<M: Debug + FileManager> Debug for Config<M> where
M::File: Debug,

impl<M> Unpin for Config<M> where
M: Unpin,

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

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

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

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

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

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

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

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,