Until this crate is published on crates.io, include the following in your Cargo.toml:
toml
[dependencies]
ur = { git = "https://github.com/dspicher/ur-rs", rev = "edc32680f0f9e82705ffb8e812f91b8347d9edca" }
a proposed method of encoding binary data of arbitrary content and length so that it is suitable for transport in either URIs or QR codes.
The resulting constraints on the permissible encoding alphabet are nicely analyzed here.
The following building blocks interact to achieve this goal: - Bytewords map binary data to case-insensitive characters with a 4 bits/char efficiency (identical to hexadecimal encoding) - Fragments for transmitting multi-part messages are constructed based on a Luby transform (a particular kind of fountain encoding), generating a potentially limitless sequence of fragments, small subsets of which can restore the original message - CBOR allows for self-describing byte payloads - A properly seeded Xoshiro pseudo-random generator allows the encoding and decoding parties to agree on which message parts were combined into a fountain encoding fragment
This Rust implementation, in particular its test vectors, is based on the following reference implementations: - C++: bc-ur - Swift: URKit
Pull requests are welcome.
This project is licensed under the terms of the MIT license.