Skip to main content

CollectionOptions

Struct CollectionOptions 

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

Supported options for creating or opening a collection.

Storage layout, buffer, and segment knobs remain outside the public contract:

ⓘ
use a3s_vec::CollectionOptions;

let mut options = CollectionOptions::new().unwrap();
options.set_max_buffer_size(1024).unwrap();
options.set_segment_num(2).unwrap();

Implementations§

Source§

impl CollectionOptions

Source

pub fn new() -> Result<Self>

Source

pub fn set_read_only(&mut self, read_only: bool) -> Result<()>

Source

pub fn read_only(&self) -> bool

Source

pub fn set_durability(&mut self, value: Durability) -> Result<()>

Source

pub fn durability(&self) -> Option<Durability>

Source

pub fn set_io_backend(&mut self, value: IoBackend) -> Result<()>

Overrides the process-wide derived-sidecar I/O backend for this handle.

When absent, the backend configured through crate::ConfigBuilder is captured when the collection is created or opened.

Source

pub fn io_backend(&self) -> Option<IoBackend>

Returns this handle’s explicit I/O backend override, if any.

Source

pub fn set_resource_limits( &mut self, value: CollectionResourceLimits, ) -> Result<()>

Applies a typed collection-local resource policy.

Source

pub fn resource_limits(&self) -> CollectionResourceLimits

Returns the resource policy that this handle will capture.

Source

pub fn set_storage_ceilings(&mut self, value: StorageCeilings) -> Result<()>

Overrides process-wide persistence DoS ceilings for this handle.

When absent, the ceilings configured through crate::ConfigBuilder (or product defaults) are captured at create/open. Values are never inferred from host RAM or free disk.

Source

pub fn storage_ceilings(&self) -> Option<StorageCeilings>

Returns this handle’s explicit storage-ceiling override, if any.

Trait Implementations§

Source§

impl Clone for CollectionOptions

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 CollectionOptions

Source§

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

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

impl Default for CollectionOptions

Source§

fn default() -> Self

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

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.