apiculture - v0.1.0

apiculture/key

Types

Key

</> 
pub type Key {
  Key(value: String, bytes: BitArray)
}

Constructors 

  • Key(value: String, bytes: BitArray)

KeyConfig

</> 
pub type KeyConfig {
  KeyConfig(
    byte_count: option.Option(Int),
    char_count: option.Option(Int),
    alphabet: option.Option(alphabet.Alphabet),
    encoding: option.Option(encoding.Encoding),
    prefix: option.Option(String),
    separator: option.Option(String),
    checksum: option.Option(checksum.Checksum),
    checksum_bytes: option.Option(Int),
  )
}

Constructors

Values

bytes

</> 
pub fn bytes(key: Key) -> BitArray

Returns the raw bytes that were used to generate the key.

generate

</> 
pub fn generate(config: KeyConfig) -> Result(Key, error.Error)

new

</> 
pub fn new() -> KeyConfig

value

</> 
pub fn value(key: Key) -> String

Returns the string value of the key.

with_alphabet

</> 
pub fn with_alphabet(
  config: KeyConfig,
  alphabet: alphabet.Alphabet,
) -> KeyConfig

with_checksum

</> 
pub fn with_checksum(
  config: KeyConfig,
  checksum: checksum.Checksum,
) -> KeyConfig

with_checksum_bytes

</> 
pub fn with_checksum_bytes(
  config: KeyConfig,
  count: Int,
) -> KeyConfig

with_encoding

</> 
pub fn with_encoding(
  config: KeyConfig,
  encoding: encoding.Encoding,
) -> KeyConfig

with_prefix

</> 
pub fn with_prefix(
  config: KeyConfig,
  prefix: String,
) -> KeyConfig

with_random_bytes

</> 
pub fn with_random_bytes(
  config: KeyConfig,
  count: Int,
) -> KeyConfig

with_random_chars

</> 
pub fn with_random_chars(
  config: KeyConfig,
  count: Int,
) -> KeyConfig

with_separator

</> 
pub fn with_separator(
  config: KeyConfig,
  separator: String,
) -> KeyConfig

without_checksum

</> 
pub fn without_checksum(config: KeyConfig) -> KeyConfig
✨ Search Document