Struct CollectionParams

pub struct CollectionParams {
    pub shard_number: u32,
    pub on_disk_payload: bool,
    pub vectors_config: Option<VectorsConfig>,
    pub replication_factor: Option<u32>,
    pub write_consistency_factor: Option<u32>,
    pub read_fan_out_factor: Option<u32>,
    pub sharding_method: Option<i32>,
    pub sparse_vectors_config: Option<SparseVectorConfig>,
}

Fields

shard_number: u32

Number of shards in collection

on_disk_payload: bool

If true - point’s payload will not be stored in memory

vectors_config: Option<VectorsConfig>

Configuration for vectors

replication_factor: Option<u32>

Number of replicas of each shard that network tries to maintain

write_consistency_factor: Option<u32>

How many replicas should apply the operation for us to consider it successful

read_fan_out_factor: Option<u32>

Fan-out every read request to these many additional remote nodes (and return first available response)

sharding_method: Option<i32>

Sharding method

sparse_vectors_config: Option<SparseVectorConfig>

Configuration for sparse vectors

Implementations

impl CollectionParams

pub fn replication_factor(&self) -> u32

Returns the value of replication_factor, or the default value if replication_factor is unset.

pub fn write_consistency_factor(&self) -> u32

Returns the value of write_consistency_factor, or the default value if write_consistency_factor is unset.

pub fn read_fan_out_factor(&self) -> u32

Returns the value of read_fan_out_factor, or the default value if read_fan_out_factor is unset.

pub fn sharding_method(&self) -> ShardingMethod

Returns the enum value of sharding_method, or the default if the field is unset or set to an invalid enum value.

pub fn set_sharding_method(&mut self, value: ShardingMethod)

Sets sharding_method to the provided enum value.

Trait Implementations

impl Clone for CollectionParams

fn clone(&self) -> CollectionParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CollectionParams

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

Formats the value using the given formatter.

impl Default for CollectionParams

fn default() -> Self

Returns the “default value” for a type.

impl Message for CollectionParams

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for CollectionParams

fn eq(&self, other: &CollectionParams) -> 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 StructuralPartialEq for CollectionParams