Skip to main content

OpenOptions

Struct OpenOptions 

Source
pub struct OpenOptions { /* private fields */ }
Expand description

Store-open configuration.

Implementations§

Source§

impl OpenOptions

Source

pub const fn new() -> Self

Returns the default read-write, derived-durability configuration.

Source

pub const fn read_only() -> Self

Returns a pure-read configuration that takes no writer lock.

Source

pub const fn with_durability( self, mode: DurabilityMode, tier: CommitTier, ) -> Self

Selects the existing durability-policy mode and per-commit tier.

Source

pub const fn with_reader_drain_timeout(self, timeout: Duration) -> Self

Sets the grace period close gives admitted readers before cancellation.

Source

pub const fn with_max_resident_bytes(self, bytes: u64) -> Self

Sets the exact ceiling for live engine-owned anonymous bytes.

Source

pub fn with_schema(self, schema: Schema) -> Self

Declares the typed user-column schema when creating a store.

On reopen, the declaration must be an additive evolution of the persisted schema (see crate::meta::Schema::additive_evolution). A read-write open commits added nullable columns as one generation; rows written earlier read them as null. A read-only open, or any other difference, is StoreError::SchemaMismatch.

Source

pub const fn with_max_temp_bytes(self, bytes: u64) -> Self

Sets the exact ceiling for live temporary anonymous bytes.

Source

pub fn with_epoch(self, epoch: StoreEpoch) -> Self

Declares the embedding and tokenizer identity used by this handle.

The tokenizer configuration defaults to crate::fts::tokenizer::TokenizerConfig::text_default. A non-default tokenizer epoch must be paired with Self::with_tokenizer.

Source

pub fn with_tokenizer(self, tokenizer: TokenizerConfig) -> Self

Selects the tokenizer configuration used for indexing and queries.

Open rejects this configuration when its epoch differs from the declared or persisted store identity.

Trait Implementations§

Source§

impl Clone for OpenOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OpenOptions

Source§

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

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

impl Default for OpenOptions

Source§

fn default() -> Self

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

impl Eq for OpenOptions

Source§

impl PartialEq for OpenOptions

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for OpenOptions

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.