A pure rust library for representing 64, 32 and 16 bit integers as base64url encoded strings. ```txt base64url i64 u64
B21CkMCtWZA 535157120202267024 535157120202267024 fHH_W21Typg 8967229101212682904 8967229101212682904 kjsG-f3NhxI -7909720649771415790 10537023423938135826 jHamKFSl5oM -8325284168998721917 10121459904710829699 ```
An integer is efficiently stored and manipulated in memory. However the integer cannot be sent to/from a web client in a url safe manor, without some encoding scheme. This library allows you to encode the integer to/from an base64url character string.
For a video of the underlying concept in action, see here.
#![no_std] by default with no heap allocation required#![forbid(unsafe_code)]I've used this concept a number of times in personal and work projects as I find it very useful. The problem is I've had to reimplement the functionality everytime.
The motivation for this library was to design and implement the core concept once, while paying attention to metrics such as performance, correctness and compatability.
Add the following to your Cargo.toml file
toml
[dependencies]
base64id = { version = "0.3", features = ["std"] }
For #![no_std] environments the std cargo feature can be omitted.
All work is done using the Id64, Id32 and Id16 structs.
The examples below use the Id64 struct, though any Id__ struct can be used equivalently.
You can convert an i64 or u64 into an Id64 as follows
```rust
use base64id::Id64;
fn main() { let int: i64 = 1; let id = Id64::from(int);
println!("{id}"); // AAAAAAAAAAE
} ```
You can use FromStr and From<i64> to convert a String into an Id64 and then into an i64 as follows
```rust
use base64id::{Error, Id64};
use std::str::FromStr;
fn main() -> Result<(), Error> { let idstr = Id64::fromstr("PDFehCFVGqA")?; let idint = i64::from(idstr);
println!("{}", id_int); // 4337351837722417824
Ok(())
} ```
Support for Serde, Rand and SQLx can be enabled through the use of optional cargo feature flags.
You can use the rand feature flag for working with the rand crate.
```rust
use base64id::Id64;
use rand::random;
let id: Id64 = random();
println!("{id}"); // 11 random base64url characters ```
You can use the serde feature flag to drive Serialize and Deserialize on Id64.
```rust
use base64id::Id64;
use serde::{Deserialize, Serialize};
struct Record { id: Id64, }
let record = Record { id: Id64::from(0u64), };
println!("{}", serdejson::tostring(&record)?); // {"id":"AAAAAAAAAAA"} ```
You can use the sqlx feature flag for using an Id64 with SQLx SQL commands.
```rust
use base64id::Id64;
use sqlx::{
sqlite::{Sqlite, SqliteConnection},
Connection,
};
use std::str::FromStr;
let id = Id64::from_str("IkoY0lQYRrI")?; let mut conn = SqliteConnection::connect("sqlite::memory:").await?;
sqlx::query("CREATE TABLE sqlx (id INT PRIMARY KEY)") .execute(&mut conn) .await?;
sqlx::query("INSERT INTO sqlx VALUES (?)") .bind(id) .execute(&mut conn) .await?;
let output = sqlx::queryas::
println!("{output}"); // IkoY0lQYRrI ```
Licensed under either of
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.