{"id":9407296,"url":"https://github.com/sqids/sqids-rust","last_synced_at":"2025-04-08T09:09:04.987Z","repository":{"id":176747005,"uuid":"658041502","full_name":"sqids/sqids-rust","owner":"sqids","description":"Official Rust port of Sqids. Generate short unique IDs from numbers.","archived":false,"fork":false,"pushed_at":"2025-01-05T04:57:58.000Z","size":47,"stargazers_count":164,"open_issues_count":0,"forks_count":8,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-01T07:53:38.363Z","etag":null,"topics":["hashids","id","id-generator","rust","rust-lang","rustlang","short-id","short-url","sqids","uid","unique-id","unique-id-generator"],"latest_commit_sha":null,"homepage":"https://sqids.org/rust","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sqids.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2023-06-24T15:27:37.000Z","updated_at":"2025-03-16T04:29:03.000Z","dependencies_parsed_at":"2023-10-11T00:42:13.276Z","dependency_job_id":"f07f3421-2a92-4a16-904b-cc288c27a340","html_url":"https://github.com/sqids/sqids-rust","commit_stats":{"total_commits":42,"total_committers":4,"mean_commits":10.5,"dds":0.2142857142857143,"last_synced_commit":"8e4026374fccbf3e938ab48fecd189c2eea6d1f7"},"previous_names":["sqids/sqids-rust"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-rust","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-rust/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-rust/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sqids%2Fsqids-rust/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sqids","download_url":"https://codeload.github.com/sqids/sqids-rust/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247809963,"owners_count":20999816,"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":["hashids","id","id-generator","rust","rust-lang","rustlang","short-id","short-url","sqids","uid","unique-id","unique-id-generator"],"created_at":"2024-05-10T18:05:09.065Z","updated_at":"2025-04-08T09:09:04.959Z","avatar_url":"https://github.com/sqids.png","language":"Rust","readme":"# [Sqids Rust](https://sqids.org/rust)\n\n[![Latest version](https://img.shields.io/crates/v/sqids.svg)](https://crates.io/crates/sqids)\n[![Github Actions](https://img.shields.io/github/actions/workflow/status/sqids/sqids-rust/tests.yml)](https://github.com/sqids/sqids-rust/actions)\n[![Docs](https://docs.rs/sqids/badge.svg)](https://docs.rs/sqids/latest/sqids/)\n[![Downloads](https://img.shields.io/crates/d/sqids)](https://crates.io/crates/sqids)\n\n[Sqids](https://sqids.org/rust) (*pronounced \"squids\"*) is a small library that lets you **generate unique IDs from numbers**. It's good for link shortening, fast \u0026 URL-safe ID generation and decoding back into numbers for quicker database lookups.\n\nFeatures:\n\n- **Encode multiple numbers** - generate short IDs from one or several non-negative numbers\n- **Quick decoding** - easily decode IDs back into numbers\n- **Unique IDs** - generate unique IDs by shuffling the alphabet once\n- **ID padding** - provide minimum length to make IDs more uniform\n- **URL safe** - auto-generated IDs do not contain common profanity\n- **Randomized output** - Sequential input provides nonconsecutive IDs\n- **Many implementations** - Support for [40+ programming languages](https://sqids.org/)\n\n## 🧰 Use-cases\n\nGood for:\n\n- Generating IDs for public URLs (eg: link shortening)\n- Generating IDs for internal systems (eg: event tracking)\n- Decoding for quicker database lookups (eg: by primary keys)\n\nNot good for:\n\n- Sensitive data (this is not an encryption library)\n- User IDs (can be decoded revealing user count)\n\n## 🚀 Getting started\n\nAdd using cargo:\n\n```bash\ncargo add sqids\n```\n\n## 👩‍💻 Examples\n\nSimple encode \u0026 decode:\n\n```rust\n# use sqids::Sqids;\nlet sqids = Sqids::default();\nlet id = sqids.encode(\u0026[1, 2, 3])?; // \"86Rf07\"\nlet numbers = sqids.decode(\u0026id); // [1, 2, 3]\n# Ok::\u003c(), sqids::Error\u003e(())\n```\n\n\u003e **Note**\n\u003e 🚧 Because of the algorithm's design, **multiple IDs can decode back into the same sequence of numbers**. If it's important to your design that IDs are canonical, you have to manually re-encode decoded numbers and check that the generated ID matches.\n\nEnforce a *minimum* length for IDs:\n\n```rust\n# use sqids::Sqids;\nlet sqids = Sqids::builder()\n  .min_length(10)\n  .build()?;\nlet id = sqids.encode(\u0026[1, 2, 3])?; // \"86Rf07xd4z\"\nlet numbers = sqids.decode(\u0026id); // [1, 2, 3]\n# Ok::\u003c(), sqids::Error\u003e(())\n```\n\nRandomize IDs by providing a custom alphabet:\n\n```rust\n# use sqids::Sqids;\nlet sqids = Sqids::builder()\n  .alphabet(\"FxnXM1kBN6cuhsAvjW3Co7l2RePyY8DwaU04Tzt9fHQrqSVKdpimLGIJOgb5ZE\".chars().collect())\n  .build()?;\nlet id = sqids.encode(\u0026[1, 2, 3])?; // \"B4aajs\"\nlet numbers = sqids.decode(\u0026id); // [1, 2, 3]\n# Ok::\u003c(), sqids::Error\u003e(())\n```\n\nPrevent specific words from appearing anywhere in the auto-generated IDs:\n\n```rust\n# use sqids::Sqids;\nlet sqids = Sqids::builder()\n  .blocklist([\"86Rf07\".to_string()].into())\n  .build()?;\nlet id = sqids.encode(\u0026[1, 2, 3])?; // \"se8ojk\"\nlet numbers = sqids.decode(\u0026id); // [1, 2, 3]\n# Ok::\u003c(), sqids::Error\u003e(())\n```\n\n## 📝 License\n\n[MIT](LICENSE)\n","funding_links":[],"categories":["Rust"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqids%2Fsqids-rust","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsqids%2Fsqids-rust","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsqids%2Fsqids-rust/lists"}