idgenerator_thin/idgen/
id_generator_options.rs

1/*
2 * 版权属于:yitter(yitter@126.com)
3 * 开源地址:https://github.com/yitter/idgenerator
4 */
5
6pub struct IdGeneratorOptions {
7    /// 雪花计算方法,(1-漂移算法|2-传统算法),默认1
8    pub method: u8,
9
10    /// 基础时间(ms单位),不能超过当前系统时间
11    pub base_time: i64,
12
13    /// 必须由外部设定,最大值 2^WorkerIdBitLength-1
14    pub worker_id: u32,
15
16    /// 默认值6,取值范围 [1, 15](要求:序列数位长+机器码位长不超过22)
17    pub worker_id_bit_length: u8,
18
19    /// 默认值6,取值范围 [3, 21](要求:序列数位长+机器码位长不超过22)
20    pub seq_bit_length: u8,
21
22    /// 设置范围 [MinSeqNumber, 2^SeqBitLength-1],默认值0,表示最大序列数取最大值(2^SeqBitLength-1])
23    pub max_seq_number: u32,
24
25    /// 默认值5,取值范围 [5, MaxSeqNumber],每毫秒的前5个序列数对应编号0-4是保留位,其中1-4是时间回拨相应预留位,0是手工新值预留位
26    pub min_seq_number: u32,
27
28    /// 最大漂移次数(含),默认2000,推荐范围 500-20000(与计算能力有关)
29    pub top_over_cost_count: u32,
30
31    /// 生成流水序列之间的步长,默认为1。
32    pub seq_step: u8,
33}
34
35impl IdGeneratorOptions {
36    /// 创建新的生成器配置项,并赋予以下属性默认值:
37    /// - method: 1。漂移算法。
38    /// - base_time: 1582136402000。大约在`2020`年`2`月`19`日。
39    /// - worker_id_bit_length: 6。机器码占据6位。
40    /// - seq_bit_length: 6。序列数占据6位。
41    /// - max_seq_number: 0。
42    /// - min_seq_number: 5。
43    /// - top_over_cost_count: 2000。
44    /// - seq_step: 1。自增长序列步长。
45    ///
46    /// # Arguments
47    ///
48    /// * `worker_id`: 机器编号。
49    ///
50    /// returns: IdGeneratorOptions
51    ///
52    /// # Examples
53    ///
54    /// ```
55    ///
56    /// ```
57    pub fn new(worker_id: u32) -> IdGeneratorOptions {
58        IdGeneratorOptions {
59            method: 1,
60            worker_id,
61            base_time: 1582136402000,
62            worker_id_bit_length: 6,
63            seq_bit_length: 6,
64            max_seq_number: 0,
65            min_seq_number: 5,
66            top_over_cost_count: 2000,
67            seq_step: 1,
68        }
69    }
70}