Struct ShardingRouter 

pub struct ShardingRouter { /* private fields */ }

Sharding router.

Routes a key to the corresponding shard according to ShardingStrategy. From v0.3.0 supports new strategies Enum/List/Directory/Composite.

Implementations

impl ShardingRouter

pub fn new(strategy: ShardingStrategy, shards: Vec<&str>) -> Self

Create a router (legacy API: takes a strategy and a shard list).

pub fn new_enum( mapping: HashMap<String, String>, default: Option<String>, ) -> Self

Construct an enum-sharding router.

pub fn new_list( keys: HashSet<String>, target: String, default: Option<String>, ) -> Self

Construct a list-sharding router.

pub fn new_directory(table: HashMap<String, String>) -> Self

Construct a directory-sharding router.

pub fn new_composite( primary: ShardingStrategy, primary_shards: Vec<String>, secondary: ShardingStrategy, secondary_shards: Vec<String>, ) -> Self

Construct a composite-sharding router.

pub fn route(&self, key: &str) -> Result<&str, ShardingError>

Route a key to the corresponding shard.

Errors

• Returns ShardingError::NoShardsConfigured when shards is empty under Hash/Range/Date strategies.
• Returns ShardingError::NoMappingForKey when Enum/List/Directory strategies miss and no default is set.

pub fn route_by_data( &self, data: &dyn Any, extractor: &dyn ShardKeyExtractor, ) -> Result<&str, ShardingError>

Route via a data object and an extractor: first extract a key from data, then call route(key).

Errors

Returns the corresponding ShardingError when extraction or routing fails.

pub fn query_all(&self) -> &[String]

Return all shards (for broadcast queries; only valid for Hash/Range/Date).

pub fn strategy(&self) -> ShardingStrategy

Return the current strategy (cloned).

pub fn shard_count(&self) -> usize

Return the number of shards.