Struct ShardInfo 

#[non_exhaustive]
pub struct ShardInfo {
    pub shard_index: i64,
    pub shard_count: i64,
    pub text_offset: i64,
    /* private fields */
}

For a large document, sharding may be performed to produce several document shards. Each document shard contains this field to detail which shard it is.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

shard_index: i64

The 0-based index of this shard.

shard_count: i64

Total number of shards.

text_offset: i64

The index of the first character in Document.text in the overall document global text.

Implementations

impl ShardInfo

pub fn new() -> Self

pub fn set_shard_index<T: Into<i64>>(self, v: T) -> Self

Sets the value of shard_index.

Example

let x = ShardInfo::new().set_shard_index(42);

pub fn set_shard_count<T: Into<i64>>(self, v: T) -> Self

Sets the value of shard_count.

Example

let x = ShardInfo::new().set_shard_count(42);

pub fn set_text_offset<T: Into<i64>>(self, v: T) -> Self

Sets the value of text_offset.

Example

let x = ShardInfo::new().set_text_offset(42);

Trait Implementations

impl Clone for ShardInfo

fn clone(&self) -> ShardInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShardInfo

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

Formats the value using the given formatter.

impl Default for ShardInfo

fn default() -> ShardInfo

Returns the “default value” for a type.

impl Message for ShardInfo

fn typename() -> &'static str

The typename of this message.

impl PartialEq for ShardInfo

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