shardmap 0.3.2

Sharded embedded in-memory map with optional cache, protocol, and server internals
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58

//! Embedded API layers.
//!
//! This module gives names to the three intended embedded surfaces:
//!
//! - [`ShardMap`]: native typed cloneable embedded map handle.
//! - [`CodecShardMap`]: feature-gated typed facade over
//!   the raw byte engine.
//! - [`ShardCache`] / [`SharedCache`]: raw byte-oriented cache handles.
//! - [`ShardedEngine`]: the richer shared sharded engine used by server mode.
//! - [`LocalEmbeddedStore`]: owner-local stores for pinned workers.
//! - [`ShardCacheServer`]: an optional TCP protocol server over a caller-owned
//!   [`ShardedEngine`].
//! - [`ReplicatedEmbeddedStore`]: an embedded primary that can serve native
//!   read replicas and FCRP subscribers.

pub use crate::cache::{
    CacheEntry, CacheOptions, CacheRef, CacheRefMut, CacheSemanticError, CacheSemanticMatch,
    CacheVacantEntry, DEFAULT_CACHE_SHARDS, RawShardMap, RawShardMapWithShards, ShardCache,
    ShardCacheWithShards, SharedCache,
};
#[cfg(feature = "codec")]
pub use crate::codec::{
    CodecError, CodecKey, CodecKeyDecode, CodecShardMap, CodecShardMapRef, CodecShardMapWithShards,
    CodecValue, CodecValueEncode, EncodedBytes,
};
pub use crate::native::{
    ShardMap, ShardMapHasher, ShardMapOptions, ShardMapRef, ShardMapWithShards,
};
#[cfg(feature = "redis")]
pub use crate::redis_embedded::{
    EmbeddedRedis, EmbeddedRedisCommandError, EmbeddedRedisSession, PreparedEmbeddedRedisCommand,
    execute_redis_command, execute_redis_command_slices, try_execute_redis_command,
    try_execute_redis_command_slices,
};
pub use crate::storage::SharedEmbeddedStore as SharedCacheStore;
pub use crate::storage::{
    EmbeddedKeyRoute, EmbeddedRouteMode, EmbeddedSessionRoute, PackedSessionWrite,
    PreparedPointKey, SemanticCacheError, SemanticMatch, SharedEmbeddedConfig,
    SharedEmbeddedLockPolicy, SharedEmbeddedStore, shift_for, stripe_index,
};
pub use crate::storage::{EmbeddedStore as ShardedEmbeddedStore, EmbeddedStore as ShardedEngine};

#[cfg(feature = "sharded")]
pub use crate::storage::{
    LocalEmbeddedBatchReadView, LocalEmbeddedReadSlice, LocalEmbeddedReadView, LocalEmbeddedRefMut,
    LocalEmbeddedSessionBatchView, LocalEmbeddedSessionPackedView, LocalEmbeddedStore,
    LocalEmbeddedStoreBootstrap, LocalRouteError, LocalStoreAccessError, LocalStoreInstallError,
    take_local_embedded_store, with_local_embedded_store,
};

#[cfg(all(feature = "embedded", feature = "server"))]
pub use crate::server::{ServerMode, ServerRuntime, ShardCacheServer};
#[cfg(all(feature = "embedded", feature = "server"))]
pub use crate::storage::EngineHandle as ServerEngineHandle;

pub use crate::replication::{
    ReplicatedEmbeddedStore, ReplicationPrimaryServer, ReplicationReplica, ReplicationReplicaClient,
};