encode_with_settings

Function encode_with_settings 

Source
pub fn encode_with_settings(
    data: impl AsRef<[u8]>,
    settings: Settings,
) -> String
Expand description

Encodes data using given settings.

The data can then be decoded using decode_with_settings. Note that the checksum settings used when decoding must match the ones used here.

ยงExamples

Disabled checksum:

use bunk::{Checksum, Settings};
 
let settings = Settings {
    checksum: Checksum::Disabled, 
    ..Default::default()
};
let encoded = bunk::encode_with_settings(b"aftersun", settings);
let decoded = bunk::decode_with_settings(encoded, settings.checksum)?;
 
assert_eq!(decoded, b"aftersun");

Custom word length limit:

use bunk::{Checksum, Settings};
 
let settings = Settings {
    word_len: Some(5), 
    ..Default::default()
};
let encoded = bunk::encode_with_settings([231, 6, 39, 34], settings);
let decoded = bunk::decode(encoded)?; // word_len doesn't affect the decoder
 
assert_eq!(decoded, [231, 6, 39, 34]);