snowflaker 0.3.2

A Twitter snowflake algorithm simply implemented in Rust. 
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154

# `snowflake`


A `Twitter` `snowflake` algorithm simply implemented in `Rust`.

[Twitter Snowflake](https://github.com/twitter-archive/snowflake.git)

[APIs Documents](https://docs.rs/snowflaker)

## 1.`Usage`


Add this to your `Cargo.toml`:

```toml
[dependencies]
snowflaker = "0.3"

# Or

# @see SnowflakeGenerator::dynamic()

snowflaker = { version = "0.3", features = ["dynamic"] }
```

-- -

## 2.`APIs`


### 2.1.`Generator`


#### 2.1.1.`builtin`


```rust
// use the default data-center ID and worker ID
let gen = SnowflakeGenerator::builtin();
assert!(gen.is_ok());
```

#### 2.1.2.`new`


```rust
let gen = SnowflakeGenerator::new(31, 31);
assert!(gen.is_ok());

let gen = SnowflakeGenerator::new(32, 32);
assert!(gen.is_err());
```

#### 2.1.3.`dynamic`


- `@since 0.2.0`

```toml
[dependencies]
snowflaker = { version = "${version}", features = ["dynamic"] }
```

```rust
let gen = SnowflakeGenerator::dynamic();
assert!(gen.is_ok());

let rvt = gen.unwrap().next_id();
assert!(rvt.is_ok());
```

-- -

### 2.2.`Functions`


#### 2.2.1.`next_id`


```rust
// 122235238222008321
let rvt = snowflaker::next_id();
assert!(rvt.is_ok());
```

#### 2.2.2.`next_id_string`


```rust
// 122256588529602560
let rvt = snowflaker::next_id_string();
assert!(rvt.is_ok());
```

-- -

### 2.3.`Macros`


- `@since 0.3.0`

#### 2.3.1.`snowflake_builtin`


```rust
let rvt = snowflake_builtin!();
assert!(rvt.is_ok());
```

#### 2.3.2.`snowflake_builtin_string`


```rust
let rvt = snowflake_builtin_string!();
assert!(rvt.is_ok());
```

#### 2.3.3.`snowflake_dynamic`


```rust
let rvt = snowflake_dynamic!();
assert!(rvt.is_ok());
```

#### 2.3.4.`snowflake_dynamic_string`


```rust
let rvt = snowflake_dynamic_string!();
assert!(rvt.is_ok());
```

-- -

### 2.4.`Custom`


- `data-center` `ID`
- `worker` `ID`

```rust
let center_id = 16;
let worker_id = 16;

let gen = SnowflakeGenerator::new(center_id, worker_id);
assert!(gen.is_ok());
let rvt = gen.unwrap().next_id();
assert!(rvt.is_ok());
```

-- -

## 3.`Test`


### 3.1.`cargo test`


```shell
$ cargo test --features "dynamic" -- --show-output
$ cargo test --features "dynamic"
```

-- -

## 4.`Docs`


### 4.1.`features`


```shell
$ cargo doc --open --features dynamic
```