Function decode

Source

pub fn decode(
    encoded: &str,
    alphabet: &Alphabet,
) -> Result<Vec<u8>, DecodeError>

Expand description

Decodes a string back to binary data using the specified alphabet.

Automatically selects the appropriate decoding strategy based on the alphabet’s mode (BaseConversion, Chunked, or ByteRange).

§Arguments

encoded - The encoded string to decode
alphabet - The alphabet used for encoding

§Returns

A Result containing the decoded binary data, or a DecodeError if the input is invalid

§Errors

Returns DecodeError if:

The input contains invalid characters
The input is empty
The padding is invalid (for chunked mode)

§Examples

use base_d::{Alphabet, EncodingMode, encode, decode};

let chars: Vec<char> = "01".chars().collect();
let alphabet = Alphabet::new_with_mode(chars, EncodingMode::BaseConversion, None)?;
let data = b"Hi";
let encoded = encode(data, &alphabet);
let decoded = decode(&encoded, &alphabet)?;
assert_eq!(data, &decoded[..]);

Examples found in repository ?

examples/hello_world.rs (line 17)

3fn main() {
4    let config = AlphabetsConfig::load_default().unwrap();
5    let alphabet_config = config.get_alphabet("cards").expect("cards alphabet not found");
6    let chars: Vec<char> = alphabet_config.chars.chars().collect();
7    let padding = alphabet_config.padding.as_ref().and_then(|s| s.chars().next());
8    let alphabet = Alphabet::new_with_mode(chars, alphabet_config.mode.clone(), padding).unwrap();
9    
10    let data = b"Hello, World!";
11    
12    println!("Original: {}", String::from_utf8_lossy(data));
13    println!("Alphabet: cards (base-{})", alphabet.base());
14    let encoded = encode(data, &alphabet);
15    println!("Encoded:  {}", encoded);
16    
17    let decoded = decode(&encoded, &alphabet).unwrap();
18    println!("Decoded:  {}", String::from_utf8_lossy(&decoded));
19    println!("\nRoundtrip successful: {}", data == &decoded[..]);
20}

More examples

Hide additional examples

examples/custom_alphabet.rs (line 19)

3fn main() {
4    // Create a custom alphabet with just 4 DNA bases
5    let dna_alphabet = Alphabet::from_str("ACGT").unwrap();
6    
7    println!("DNA Alphabet (base-4)");
8    println!("=====================\n");
9    
10    // Encode some data
11    let data = b"DNA";
12    let encoded = encode(data, &dna_alphabet);
13    
14    println!("Original: {:?}", String::from_utf8_lossy(data));
15    println!("Encoded:  {}", encoded);
16    println!("Length:   {} bases\n", encoded.len());
17    
18    // Decode it back
19    let decoded = decode(&encoded, &dna_alphabet).unwrap();
20    println!("Decoded:  {:?}", String::from_utf8_lossy(&decoded));
21    println!("Match:    {}", data == &decoded[..]);
22    
23    // Try different data
24    println!("\n---\n");
25    let data2 = &[0xFF, 0x00, 0x42];
26    let encoded2 = encode(data2, &dna_alphabet);
27    println!("Binary {:?} encodes to: {}", data2, encoded2);
28}

decode