Struct rincon_client::collection::types::CollectionProperties

pub struct CollectionProperties { /* fields omitted */ }

This struct holds the properties of a collection.

It is returned by the GetCollectionProperties method.

Methods

impl CollectionProperties

pub fn id(&self) -> &str

Returns the id of the collection.

pub fn name(&self) -> &str

Returns the name of the collection.

pub fn kind(&self) -> CollectionType

Returns the type of the collection.

pub fn status(&self) -> CollectionStatus

Returns the status of the collection.

pub fn is_system(&self) -> bool

Returns whether the collection is a system or regular collection.

pub fn key_options(&self) -> &KeyOptions

Returns the key options of the collection.

pub fn is_wait_for_sync(&self) -> bool

Returns whether the server waits for sync to the filesystem before sending the response.

pub fn number_of_shards(&self) -> u16

Returns the number of shards for this collection.

pub fn shard_keys(&self) -> &str

Returns the keys to determine the shard for a collection.

pub fn replication_factor(&self) -> u64

Returns the number of copies that are kept of each shard.

pub fn is_volatile(&self) -> bool

Returns whether this collection is a volatile collection.

pub fn is_do_compact(&self) -> bool

Returns whether this collection is compacted.

pub fn index_buckets(&self) -> u16

Returns the number of buckets into which indexes using a hash table are split.

pub fn journal_size(&self) -> u64

Returns the maximal size of a journal or datafile in bytes.

Trait Implementations

impl From<CollectionProperties> for Collection

fn from(properties: CollectionProperties) -> Self

Performs the conversion.

impl From<CollectionProperties> for BasicCollectionProperties

fn from(properties: CollectionProperties) -> Self

Performs the conversion.

impl Debug for CollectionProperties

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

Formats the value using the given formatter.

impl Clone for CollectionProperties

fn clone(&self) -> CollectionProperties

Returns a copy of the value.

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

Performs copy-assignment from source.