Skip to content

Latest commit

 

History

History
72 lines (48 loc) · 3.02 KB

README.md

File metadata and controls

72 lines (48 loc) · 3.02 KB

rust-multibase

Build Status License Crates.io Documentation Dependency Status Coverage Status

multibase implementation in Rust.

Table of Contents

Install

First add this to your Cargo.toml

[dependencies]
multibase = "0.9"

For no_std

[dependencies]
multibase = { version ="0.9", default-features = false }

note: This crate relies on the currently unstable host_dep feature to compile proc macros with the proper dependencies, thus requiring nightly rustc to use.

Then run cargo build.

Usage

use multibase::Base;

let base64 = multibase::encode(Base::Base64, b"hello world");
let (base, data) = multibase::decode(base64);

Note: base32 and base64 are orders of magnitude faster due to byte alignment. Don't be surprised if using a different base turns into a performance bottleneck. You were warned!

Maintainers

Captain: @dignifiedquire.

Contribute

Contributions welcome. Please check out the issues.

Check out our contributing document for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS Code of Conduct.

Small note: If editing the README, please conform to the standard-readme specification.

License

MIT © Friedel Ziegelmayer