Struct ShardKey 

pub struct ShardKey {
    pub fields: Vec<(String, ShardKeyType)>,
    pub unique: bool,
}

A shard key definition.

Fields

fields: Vec<(String, ShardKeyType)>

Fields in the shard key.

unique: bool

Whether the collection is unique on the shard key.

Implementations

impl ShardKey

pub fn builder() -> ShardKeyBuilder

Create a new shard key builder.

pub fn shard_collection_command( &self, database: &str, collection: &str, ) -> Value

Get the shardCollection command.

pub fn index_spec(&self) -> Value

Get the index specification for the shard key.

Trait Implementations

impl Clone for ShardKey

fn clone(&self) -> ShardKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShardKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShardKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ShardKey

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ShardKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ShardKey

impl StructuralPartialEq for ShardKey