Struct hcid::HcidEncodingConfig

pub struct HcidEncodingConfig {
    pub key_byte_count: usize,
    pub base_parity_byte_count: usize,
    pub cap_parity_byte_count: usize,
    pub prefix: Vec<u8>,
    pub prefix_cap: Vec<u8>,
    pub cap_segment_char_count: usize,
    pub encoded_char_count: usize,
}

represents an encoding configuration for hcid rendering and parsing

Fields

key_byte_count: usize

byte count of actuall key data that will be encoded

base_parity_byte_count: usize

parity bytes that will be encoded directly into the base32 string (appended after key)

cap_parity_byte_count: usize

parity bytes that will be encoded in the alpha capitalization (appended after base parity)

prefix: Vec<u8>

bytes to prefix before rendering to base32

prefix_cap: Vec<u8>

binary indication of the capitalization for prefix characters

cap_segment_char_count: usize

how many characters are in a capitalization parity segment

encoded_char_count: usize

how many characters long the fully rendered base32 string should be

Methods

impl HcidEncodingConfig

pub fn new(kind: &str) -> HcidResult<Self>

create a new config given a kind token string

Example

extern crate hcid;
let hca0 = hcid::HcidEncodingConfig::new("hca0").unwrap();
let hck0 = hcid::HcidEncodingConfig::new("hck0").unwrap();
let hcs0 = hcid::HcidEncodingConfig::new("hcs0").unwrap();