apiculture/alphabet

Alphabet representation and validation.

An alphabet is a validated set of graphemes for direct random character sampling. It is deliberately separate from an encoding, which transforms arbitrary bytes into text.

Types

Alphabet

</>

An alphabet is a character repertoire used for direct sampling. This is distinct from an encoding, which transforms bytes to text.

pub type Alphabet {
  Alphabet(chars: String)
}

Constructors

```
Alphabet(chars: String)
```

Values

characters

</>

pub fn characters(alphabet: Alphabet) -> List(String)

Returns the characters in the alphabet as a list of graphemes.

new_alphabet

</>

pub fn new_alphabet(
  chars: String,
) -> Result(Alphabet, error.Error)

Creates a new alphabet from a string of characters.

Returns an error if the alphabet is empty, has only one character, or contains duplicate characters.

size

</>

pub fn size(alphabet: Alphabet) -> Int

Returns the size (number of characters) in the alphabet.