Struct ejdb::CollectionOptions

pub struct CollectionOptions {
    pub large: bool,
    pub compressed: bool,
    pub records: i64,
    pub cached_records: i32,
}

Represents a set of options of an EJDB collection.

Used when new collections are created. It is not possible to change options of a created collection.

This is a builder object, so you can chain method calls to set various options. Finally, you can create a collection with these options with get_or_create() method.

Example

let options = CollectionOptions::default()
    .large(true)
    .compressed(true)
    .records(1_024_000)
    .cached_records(1024);

Fields

large: bool

Make the collection "large", i.e. able to hold more than 2GB of data. Default is false.

compressed: bool

Compress records in the collection with DEFLATE. Default is false.

records: i64

Expected number of records in the collection. Default is 128 000.

cached_records: i32

Maximum number of records cached in memory. Default is 0.

Methods

impl CollectionOptions

pub fn large(self, large: bool) -> CollectionOptions

pub fn compressed(self, compressed: bool) -> CollectionOptions

pub fn records(self, records: i64) -> CollectionOptions

pub fn cached_records(self, cached_records: i32) -> CollectionOptions

pub fn get_or_create<S: Into<Vec<u8>>>(
    self,
    db: &Database,
    name: S
) -> Result<Collection>

Invokes db.collection_with_options(name, options) with this object as an argument.

This is a convenience method which allows setting options and creating a collection in one go. Remember that if collection with the specified name already exists, it will be returned and options will be ignored.

name argument can be of any type which is convertible to a vector of bytes, like string or byte slice.

Example

let db = Database::open("/path/to/db").unwrap();
let coll = CollectionOptions::default()
    .large(true).compressed(true)
    .records(1_024_000).cached_records(1024)
    .get_or_create(&db, "new_collection").unwrap();
// work with the collection

Trait Implementations

impl PartialEq<CollectionOptions> for CollectionOptions

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Default for CollectionOptions

fn default() -> CollectionOptions

Returns the "default value" for a type.

impl Clone for CollectionOptions

fn clone(&self) -> CollectionOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for CollectionOptions

impl Debug for CollectionOptions

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

Formats the value using the given formatter.