Struct Base64UrlSafe

pub struct Base64UrlSafe;

URL-safe Base64 encoder and decoder with padding.

This implementation follows the URL-safe Base64 encoding variant as defined in RFC 4648. It replaces the ‘+’ and ‘/’ characters with ‘-’ and ‘_’ to make the output URL and filename safe. Padding characters (‘=’) are included when needed.

URL-safe Base64 Alphabet

The URL-safe Base64 alphabet uses characters:

• ‘A’ to ‘Z’ (26 characters)
• ‘a’ to ‘z’ (26 characters)
• ‘0’ to ‘9’ (10 characters)
• ‘-’ and ‘_’ (2 characters)
• ‘=’ (padding character)

Examples

use ct_codecs::{Base64UrlSafe, Encoder, Decoder};

fn example() -> Result<(), ct_codecs::Error> {
    let data = b"Hello, world!";
    let encoded = Base64UrlSafe::encode_to_string(data)?;
    assert_eq!(encoded, "SGVsbG8sIHdvcmxkIQ==");

    // If the input contains characters that would be escaped in URLs
    let binary_data = &[251, 239, 190, 222];
    let encoded = Base64UrlSafe::encode_to_string(binary_data)?;
    assert_eq!(encoded, "----3g==");
    Ok(())
}

Trait Implementations

impl Decoder for Base64UrlSafe

fn decode<'t, IN: AsRef<[u8]>>( bin: &'t mut [u8], b64: IN, ignore: Option<&[u8]>, ) -> Result<&'t [u8], Error>

Decodes text data back into its binary representation.

fn decode_to_vec<IN: AsRef<[u8]>>( encoded: IN, ignore: Option<&[u8]>, ) -> Result<Vec<u8>, Error>

Decodes text data and returns the result as a Vec.

impl Encoder for Base64UrlSafe

fn encoded_len(bin_len: usize) -> Result<usize, Error>

Calculates the length of the encoded output for a given binary input length.

fn encode<IN: AsRef<[u8]>>(b64: &mut [u8], bin: IN) -> Result<&[u8], Error>

Encodes binary data into a text representation.

fn encode_to_str<IN: AsRef<[u8]>>( encoded: &mut [u8], bin: IN, ) -> Result<&str, Error>

Encodes binary data and returns the result as a string slice.

fn encode_to_string<IN: AsRef<[u8]>>(bin: IN) -> Result<String, Error>

Encodes binary data and returns the result as a String.