{"id":21462157,"url":"https://github.com/wolfpup-software/snowprints-rs","last_synced_at":"2025-03-17T05:12:02.383Z","repository":{"id":237567477,"uuid":"794767581","full_name":"wolfpup-software/snowprints-rs","owner":"wolfpup-software","description":"create unique ids","archived":false,"fork":false,"pushed_at":"2025-02-18T23:17:31.000Z","size":21,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-19T00:24:42.617Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wolfpup-software.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-05-01T22:59:21.000Z","updated_at":"2025-02-18T23:17:32.000Z","dependencies_parsed_at":"2024-11-23T07:12:55.431Z","dependency_job_id":"b354bd7e-639e-49f4-aa2a-2d3ec0e6e831","html_url":"https://github.com/wolfpup-software/snowprints-rs","commit_stats":null,"previous_names":["taylor-vann/snowprints","wolfpup-software/snowprints-rs"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wolfpup-software%2Fsnowprints-rs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wolfpup-software%2Fsnowprints-rs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wolfpup-software%2Fsnowprints-rs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wolfpup-software%2Fsnowprints-rs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wolfpup-software","download_url":"https://codeload.github.com/wolfpup-software/snowprints-rs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243976487,"owners_count":20377691,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-23T07:12:53.564Z","updated_at":"2025-03-17T05:12:02.375Z","avatar_url":"https://github.com/wolfpup-software.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Snowprints-rs\n\nCreate unique and sortable ids.\n\n## How to use\n\n### Settings\n\nDefine a `Settings` struct.\n\nThe `logical_volume_base` property defines where to begin logical volume rotations. The `logical_volume_length` property defines how many logical volumes will be rotated.\n\n```rust\nuse snowprints::Settings;\n\n// THIS VALUE CANNOT BE CHANGED FOR THE ENTIRE SOFTWARE / SYSTEM LIFETIME\nconst JANUARY_1ST_2024_AS_MS: u64 = 1704096000000;\n\nlet settings = Settings {\n    origin_time_ms: JANUARY_1ST_2024_AS_MS,\n    logical_volume_base: 0,\n    logical_volume_length: 8192,\n};\n```\n\n### Compose\n\nIn the example below, `Snowprints` start on `2024 Jan 1st` and rotate through logical volumes `0-8191`.\n\n```rust\nuse snowprints::Snowprints;\n\nlet mut snowprinter = match Snowprints::new(settings) {\n    Ok(snow) =\u003e snow,\n    _ =\u003e return println!(\"Settings are not valid!\"),\n};\n\nlet snowprint = match snowprinter.compose() {\n    Ok(sp) =\u003e sp,\n    _ =\u003e return println!(\"Exhausted all available logical volumes and sequences for the current millisecond!\"),\n};\n```\n\n### Decompose\n\nTo get values from a `snowprint` use the `decompose` function.\n\n```rust\nuse snowprints::decompose;\n\nlet (timestamp_ms, logical_volume, sequence) = decompose(snowprint);\n```\n\n## What is a snowprint?\n\nA `snowprint` is a [snowflake id](https://en.wikipedia.org/wiki/Snowflake_ID) variant based on this [article](https://instagram-engineering.com/sharding-ids-at-instagram-1cf5a71e5a5c).\n\nI called them snowprints because this library creates a \"sequential trail\" of snowflake IDs across all available logical volumes.\n\n## License\n\n`Snowprints` is released under the BSD 3-Clause License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwolfpup-software%2Fsnowprints-rs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwolfpup-software%2Fsnowprints-rs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwolfpup-software%2Fsnowprints-rs/lists"}