tiltflake 0.1.1

Tiltflake is a distributed database that uses the flake algorithm to generate unique 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
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

<div align="center">

[![Preview](/assets/images/hero.png)](https://github.com/t1ltxz-gxd/tiltflake)
<p>A strict, deterministic, and time-traveling Snowflake ID generator for Rust — supports timewalk generation from SystemTime, DateTime<Utc>, epoch milliseconds, or RFC3339 strings.</p>

---
[![GitHub License](https://img.shields.io/github/license/t1ltxz-gxd/tiltflake)](https://github.com/t1ltxz-gxd/tiltflake/blob/main/LICENSE "license")
[![Tests](https://img.shields.io/github/actions/workflow/status/t1ltxz-gxd/tiltflake/ci.yml?style=flat-square&logo=github&label=Tests)](https://github.com/t1ltxz-gxd/tiltflake/tests)
[![Forks](https://custom-icon-badges.demolab.com/github/forks/t1ltxz-gxd/tiltflake?logo=fork)](https://github.com/t1ltxz-gxd/tiltflake/network/members)
[![Contributors](https://custom-icon-badges.demolab.com/github/contributors/t1ltxz-gxd/tiltflake?logo=people)](https://github.com/t1ltxz-gxd/tiltflake/graphs/contributors)
[![Stars](https://custom-icon-badges.demolab.com/github/stars/t1ltxz-gxd/tiltflake?logo=star)](https://github.com/t1ltxz-gxd/tiltflake/stargazers)
[![Open issues](https://custom-icon-badges.demolab.com/github/issues-raw/t1ltxz-gxd/tiltflake?logo=issue)](https://github.com/t1ltxz-gxd/tiltflake/issues)


[![Powered by Rust](https://custom-icon-badges.herokuapp.com/badge/-Powered%20by%20Rust-0d1620?logo=rust)](https://www.rust-lang.org/ "Powered by Rust")
</div>

___

## 🧩 Installation
Add the following to your `Cargo.toml` file:
```toml
[dependencies]
tiltflake = {version = "*", features = ["serde"]}
```

## 📖 Usage

### Generate a Snowflake ID with a UNIX epoch
```rust
use tiltflake::flake::Tiltflake;
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
	let generator = Tiltflake::builder().build(); // Default machine_id is 1 and epoch is Unix
	let id = generator.generate_from_rfc3339("2025-04-08T12:00:00Z", 0)?;
	println!("Snowflake ID: {}", id);

	let (dt, machine_id, seq) = generator.parse(id);
	println!(
		"Parsed: {}, machine_id={}, sequence={}",
		dt, machine_id, seq
	);

	Ok(())
}
```

### Generate a Snowflake ID with a custom epoch
```rust
use chrono::{TimeZone, Utc};
use tiltflake::{epoch::EpochType, flake::Tiltflake};

fn main() -> Result<(), Box<dyn std::error::Error>> {
	let epoch = EpochType::Custom(
		Utc.with_ymd_and_hms(2020, 1, 1, 0, 0, 0).single().unwrap(),
	);
	let generator = Tiltflake::builder()
		.with_epoch(epoch)
		.with_machine_id(1)
		.build();
	let id = generator.generate_from_rfc3339("2025-04-08T12:00:00Z", 0)?;
	println!("Snowflake ID: {}", id);

	let (dt, machine_id, seq) = generator.parse(id);
	println!(
		"Parsed: {}, machine_id={}, sequence={}",
		dt, machine_id, seq
	);

	Ok(())
}
```

### Generate a Snowflake ID with a custom Discord epoch
```rust
use tiltflake::{epoch::EpochType, flake::Tiltflake};
use std::error::Error;

fn main() -> Result<(), Box<dyn Error>> {
	let generator = Tiltflake::builder()
		.with_machine_id(1)
		.with_epoch(EpochType::Discord)
		.build();
	let id = generator.generate_from_rfc3339("2025-04-08T12:00:00Z", 0)?;
	println!("Snowflake ID: {}", id);

	let (dt, machine_id, seq) = generator.parse(id);
	println!(
		"Parsed: {}, machine_id={}, sequence={}",
		dt, machine_id, seq
	);

	Ok(())
}
```

### See all examples in the `examples` folder.

___

## 🤝 Contributing

Contributions are what make the open source community an amazing place to learn, be inspired, and create.
Any contributions you make are **greatly appreciated**.

1. [Fork the repository](https://github.com/t1ltxz-gxd/tiltflake/fork)
2. Clone your fork `git clone https://github.com/t1ltxz-gxd/tiltflake.git`
3. Create your feature branch `git checkout -b feat-smth-amazing`
4. Stage changes `git add .`
5. Commit your changes `git commit -m 'feat: add some amazing feature'`
   - Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
   - Use `fix`, `feat`, `docs`, `style`, `refactor`, `perf`, `test`, `chore` prefixes.
   - Use the present tense ("add feature" not "added feature").
   - Use the imperative mood ("move cursor to..." not "moves cursor to...").
   - Limit the first line to 72 characters or less.
   - Reference issues and pull requests liberally after the first line.
6. Push to the branch `git push origin feat-smth-amazing`
7. Submit a pull request

## ❤️ Credits

Released with ❤️ by [Tilt](https://github.com/t1ltxz-gxd).