ferroid-tonic-core 0.3.9

A flexible ID generator for producing unique, monotonic, and lexicographically sortable Snowflake-style IDs.
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

//! # Shared Types and Protobuf Bindings
//!
//! This crate provides the shared interface and protocol definitions for the
//! `ferroid` streaming ID generation ecosystem. It is consumed by both the gRPC
//! server and external clients that interact with it programmatically.
//!
//! ## Contents
//!
//! - Canonical Snowflake ID types and encoding constants
//! - Shared [`Error`] and [`Result`] types used across the system
//! - Auto-generated protobuf bindings for the gRPC interface (`ferroid.proto`)
//!
//! ## Protobuf Interface
//!
//! The [`proto`] module contains types generated via [`tonic::include_proto!`].
//! It also exposes the precompiled [`FILE_DESCRIPTOR_SET`] for gRPC reflection
//! support.
//!
//! Example client usage:
//!
//! ```rust
//! use ferroid_tonic_core::proto::id_generator_client::IdGeneratorClient;
//! ```
//!
//! gRPC clients should deserialize `IdChunk.packed_ids` using the agreed-upon
//! fixed-width layout (e.g. `u64` or `u128`, in little-endian order).
//!
//! [`FILE_DESCRIPTOR_SET`]: crate::proto::FILE_DESCRIPTOR_SET

mod common;
pub use common::*;

// Public re-export so downstream crates can access `ferroid` via
// `ferroid_tonic_core::ferroid`
pub use ferroid;