Module base64

Expand description

Base64 encoding and decoding.

base64 provides encoding and decoding for Base64, a binary-to-text encoding scheme that represents binary data in a printable ASCII string format. Base64 is commonly used for encoding binary data in contexts where only text can be stored or transmitted, such as email attachments, URLs, and data URIs.

The crate supports multiple Base64 alphabets and configurations, including standard Base64, URL-safe Base64, and custom alphabets. The main functions are encode and decode for simple operations, and the Engine trait for more advanced usage with custom configurations.

§Examples

Basic encoding and decoding:

use base64::{encode, decode};

let original = "Hello, world!";
let encoded = encode(original);
println!("Encoded: {}", encoded); // "SGVsbG8sIHdvcmxkIQ=="

let decoded = decode(&encoded).unwrap();
let decoded_str = String::from_utf8(decoded).unwrap();
println!("Decoded: {}", decoded_str); // "Hello, world!"

Using URL-safe encoding for use in URLs:

use base64::{Engine as _, engine::general_purpose};

let data = b"data with/special+chars";
let encoded = general_purpose::URL_SAFE_NO_PAD.encode(data);
println!("URL-safe: {}", encoded); // Uses - and _ instead of + and /

let decoded = general_purpose::URL_SAFE_NO_PAD.decode(&encoded).unwrap();
assert_eq!(decoded, data);

Modules§

alphabet: Provides Alphabet and constants for alphabets commonly used in the wild.
display: Enables base64’d output anywhere you might use a Display implementation, like a format string.
engine: Provides the Engine abstraction and out of the box implementations.
prelude: Preconfigured engines for common use cases.
read: Implementations of io::Read to transparently decode base64.
write: Implementations of io::Write to transparently handle base64.

Enums§

DecodeError: Errors that can occur while decoding.
DecodeSliceError: Errors that can occur while decoding into a slice.
EncodeSliceError: Errors that can occur while encoding into a slice.

Traits§

Engine: An Engine provides low-level encoding and decoding operations that all other higher-level parts of the API use. Users of the library will generally not need to implement this.

Functions§