Struct ShardBits 

pub struct ShardBits(/* private fields */);

The number of leading key hash bits that select the shard, i.e. a family has 2^bits shards.

Implementations

impl ShardBits

pub const MAX: ShardBits

The largest supported value, i.e. 4096 shards.

pub const fn new(bits: u8) -> Self

Panics if bits exceeds ShardBits::MAX.

pub fn try_new(bits: u8) -> Option<Self>

Returns None if bits exceeds ShardBits::MAX.

pub fn get(self) -> u8

The number of leading key hash bits.

pub fn count(self) -> u32

The number of shards.

pub fn shard_of(self, hash: u64) -> u32

Returns the shard that contains hash.

pub fn range(self, index: u32) -> RangeInclusive<u64>

Returns the range of key hashes in the shard index.

pub fn maybe_reshard(self, bytes: u64, target_shard_size: u64) -> Self

Computes the shard bits for a family with size bytes, targeting a shard size and using self bits already.

The shard count only doubles once shards hold more than 1.5 times target_shard_size, and only halves once they hold less than half of it to prevent resharding around a threshold.

pub fn maybe_grow(self, bytes: u64, target_shard_size: u64) -> Self

Like Self::maybe_reshard, but never shrinks.

Trait Implementations

impl Clone for ShardBits

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ShardBits

impl Debug for ShardBits

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

Formats the value using the given formatter.

impl Default for ShardBits

fn default() -> Self

Returns the “default value” for a type.

impl Eq for ShardBits

impl Ord for ShardBits

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for ShardBits

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for ShardBits

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for ShardBits