sfid 0.1.12

Distributed Snowflake ID generator with Redis-based auto machine ID allocation / 基于 Redis 自动分配机器号的分布式雪花 ID 生成器
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

#![cfg_attr(docsrs, feature(doc_cfg))]

mod bits;
pub use bits::{DefaultLayout, Layout};

mod error;
pub use error::{Error, Result};

/// Clock backward threshold in seconds
/// 时钟回拨告警阈值（秒）
const CLOCK_BACKWARD_WARN_SEC: u64 = 1;

/// Default epoch: 2025-12-22 00:00:00 UTC (seconds)
/// 默认纪元：2025-12-22 00:00:00 UTC（秒）
pub const EPOCH: u64 = 1766361600;

#[cfg(feature = "auto_pid")]
mod pid;
#[cfg(feature = "auto_pid")]
#[cfg_attr(docsrs, doc(cfg(feature = "auto_pid")))]
pub use pid::{Pid, allocate};

#[cfg(feature = "snowflake")]
mod sfid;
#[cfg(feature = "snowflake")]
#[cfg_attr(docsrs, doc(cfg(feature = "snowflake")))]
pub use sfid::SfId;

#[cfg(feature = "parse")]
mod parse;
#[cfg(feature = "parse")]
#[cfg_attr(docsrs, doc(cfg(feature = "parse")))]
pub use parse::{ParsedId, parse, parse_with};

/// Create SfId with Redis-allocated process ID
/// 使用 Redis 分配的进程号创建 SfId
#[cfg(feature = "auto_pid")]
#[cfg_attr(docsrs, doc(cfg(feature = "auto_pid")))]
pub async fn new(app: impl AsRef<[u8]>) -> Result<SfId> {
  let pid_handle = allocate::<DefaultLayout>(app).await?;
  Ok(SfId::with_pid(EPOCH, pid_handle))
}