# LLM Prompt for Documentation ## Documentation ### Ascii #### Ascii **Type Annotation** #### from_str **Type Annotation** ```roc Str -> Result Ascii [InvalidAscii] ``` **Description** Convert a UTF-8 [Str] to an ASCII string. #### to_str **Type Annotation** ```roc Ascii -> Str ``` **Description** Convert an ASCII string to a UTF-8 [Str]. #### from_ascii_bytes **Type Annotation** ```roc List U8 -> Result Ascii [InvalidAscii] ``` **Description** Convert a list of ASCII code points to an ASCII string. #### to_ascii_bytes **Type Annotation** ```roc Ascii -> List U8 ``` **Description** Convert an ASCII string to a list of ASCII code points. #### compare **Type Annotation** ```roc Ascii, Ascii -> [ LT, EQ, GT ] ``` **Description** Compare the [ASCIIbetical](https://en.wikipedia.org/wiki/ASCII#Character_order) order of two ASCII strings, i.e. by comparing their code points. #### is_empty **Type Annotation** ```roc Ascii -> Bool ``` **Description** Check if an ASCII string is empty. #### to_uppercase **Type Annotation** ```roc Ascii -> Ascii ``` **Description** Convert all the lowercase letters in an ASCII string to uppercase, leaving all other characters unchanged. #### to_lowercase **Type Annotation** ```roc Ascii -> Ascii ``` **Description** Convert all the uppercase letters in an ASCII string to lowercase, leaving all other characters unchanged. #### concat **Type Annotation** ```roc Ascii, Ascii -> Ascii ``` **Description** Concatenate two ASCII strings. #### join **Type Annotation** ```roc List Ascii -> Ascii ``` **Description** Join a list of ASCII strings. #### join_with **Type Annotation** ```roc List Ascii, Ascii -> Ascii ``` **Description** Join a list of ASCII strings with a separator. #### repeat **Type Annotation** ```roc Ascii, U64 -> Ascii ``` **Description** Repeat an ASCII string a specified number of times. #### starts_with **Type Annotation** ```roc Ascii, Ascii -> Bool ``` **Description** Check if an ASCII string starts with another ASCII string. #### ends_with **Type Annotation** ```roc Ascii, Ascii -> Bool ``` **Description** Check if an ASCII string ends with another ASCII string. #### to_dec **Type Annotation** ```roc Ascii -> Result Dec [InvalidNumStr] ``` #### to_f64 **Type Annotation** ```roc Ascii -> Result F64 [InvalidNumStr] ``` #### to_f32 **Type Annotation** ```roc Ascii -> Result F32 [InvalidNumStr] ``` #### to_u128 **Type Annotation** ```roc Ascii -> Result U128 [InvalidNumStr] ``` #### to_i128 **Type Annotation** ```roc Ascii -> Result I128 [InvalidNumStr] ``` #### to_u64 **Type Annotation** ```roc Ascii -> Result U64 [InvalidNumStr] ``` #### to_i64 **Type Annotation** ```roc Ascii -> Result I64 [InvalidNumStr] ``` #### to_u32 **Type Annotation** ```roc Ascii -> Result U32 [InvalidNumStr] ``` #### to_i32 **Type Annotation** ```roc Ascii -> Result I32 [InvalidNumStr] ``` #### to_u16 **Type Annotation** ```roc Ascii -> Result U16 [InvalidNumStr] ``` #### to_i16 **Type Annotation** ```roc Ascii -> Result I16 [InvalidNumStr] ``` #### to_u8 **Type Annotation** ```roc Ascii -> Result U8 [InvalidNumStr] ``` #### to_i8 **Type Annotation** ```roc Ascii -> Result I8 [InvalidNumStr] ``` #### len **Type Annotation** ```roc Ascii -> U64 ``` **Description** Count the number of characters in an ASCII string. #### reverse **Type Annotation** ```roc Ascii -> Ascii ``` **Description** Reverse the characters in an ASCII string. #### sort_asc **Type Annotation** ```roc List Ascii -> List Ascii ``` **Description** Sort a list of ASCII strings in ascending [ASCIIbetical](https://en.wikipedia.org/wiki/ASCII#Character_order) order. #### sort_desc **Type Annotation** ```roc List Ascii -> List Ascii ``` **Description** Sort a list of ASCII strings in descending [ASCIIbetical](https://en.wikipedia.org/wiki/ASCII#Character_order) order. ### Char #### Char **Type Annotation** **Description** A single ASCII character. #### from_ascii_byte **Type Annotation** ```roc U8 -> Result Char [InvalidAscii] ``` **Description** Parse an ASCII code point to a [Char], returning an error if the code point is not in the range 0 to 127 inclusive. #### to_ascii_byte **Type Annotation** ```roc Char -> U8 ``` **Description** Get the corresponding ASCII code point of a [Char]. #### compare **Type Annotation** ```roc Char, Char -> [ LT, EQ, GT ] ``` **Description** Compare the [ASCIIbetical](https://en.wikipedia.org/wiki/ASCII#Character_order) order of two ASCII characters, i.e. by comparing their code points. #### character_set **Type Annotation** ```roc Char -> [ LowercaseLetter, UppercaseLetter, Digit, Whitespace, Punctuation, Control ] ``` **Description** Get the ASCII character set of a character. #### is_lowercase **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a lowercase letter. #### is_uppercase **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is an uppercase letter. #### is_letter **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a letter. #### is_digit **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a digit. #### is_alphanumeric **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is an alphanumeric character, i.e. a letter or a digit. #### is_oct_digit **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is an octal digit, i.e. a digit in the range 0 to 7 inclusive. #### is_hex_digit **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a hexadecimal digit, i.e. a digit or a letter in the range 0 to 9, a to f, or A to F. #### is_whitespace **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a whitespace character. #### is_punctuation **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a punctuation character. #### is_control **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a control character. #### is_printable **Type Annotation** ```roc Char -> Bool ``` **Description** Check if an ASCII character is a printable character. #### to_uppercase **Type Annotation** ```roc Char -> Char ``` **Description** Convert a character to uppercase if it is a lowercase letter, otherwise return the character unchanged. #### to_lowercase **Type Annotation** ```roc Char -> Char ``` **Description** Convert a character to lowercase if it is an uppercase letter, otherwise return the character unchanged. #### lowercase_alphabet **Type Annotation** ```roc List Char ``` **Description** All the lowercase ASCII letters. #### uppercase_alphabet **Type Annotation** ```roc List Char ``` **Description** All the uppercase ASCII letters. #### alphabet **Type Annotation** ```roc List Char ``` **Description** All the ASCII letters. #### digits **Type Annotation** ```roc List Char ``` **Description** All the ASCII digits. #### whitespace **Type Annotation** ```roc List Char ``` **Description** All the ASCII whitespace characters. #### punctuation **Type Annotation** ```roc List Char ``` **Description** All the ASCII punctuation characters. #### control **Type Annotation** ```roc List Char ``` **Description** All the ASCII control characters. #### printable **Type Annotation** ```roc List Char ``` **Description** All the ASCII printable characters. #### nul **Type Annotation** ```roc Char ``` **Description** The ASCII "Null" (␀) control character #### soh **Type Annotation** ```roc Char ``` **Description** The ASCII "Start of Heading" (␁) control character #### stx **Type Annotation** ```roc Char ``` **Description** The ASCII "Start of Text" (␂) control character #### etx **Type Annotation** ```roc Char ``` **Description** The ASCII "End of Text" (␃) control character #### eot **Type Annotation** ```roc Char ``` **Description** The ASCII "End of Transmission" (␄) control character #### enq **Type Annotation** ```roc Char ``` **Description** The ASCII "Enquiry" (␅) control character #### ack **Type Annotation** ```roc Char ``` **Description** The ASCII "Acknowledgement" (␆) control character #### bel **Type Annotation** ```roc Char ``` **Description** The ASCII "Bell" (␇) control character #### bs **Type Annotation** ```roc Char ``` **Description** The ASCII "Backspace" (␈) control character #### ht **Type Annotation** ```roc Char ``` **Description** The ASCII "Horizontal Tab" (␉) control character #### lf **Type Annotation** ```roc Char ``` **Description** The ASCII "Line Feed" (␊) control character #### vt **Type Annotation** ```roc Char ``` **Description** The ASCII "Vertical Tab" (␋) control character #### ff **Type Annotation** ```roc Char ``` **Description** The ASCII "Form Feed" (␌) control character #### cr **Type Annotation** ```roc Char ``` **Description** The ASCII "Carriage Return" (␍) control character #### so **Type Annotation** ```roc Char ``` **Description** The ASCII "Shift Out" (␎) control character #### si **Type Annotation** ```roc Char ``` **Description** The ASCII "Shift In" (␏) control character #### dle **Type Annotation** ```roc Char ``` **Description** The ASCII "Data Link Escape" (␐) control character #### dc1 **Type Annotation** ```roc Char ``` **Description** The ASCII "Device Control 1/XON" (␑) control character #### dc2 **Type Annotation** ```roc Char ``` **Description** The ASCII "Device Control 2" (␒) control character #### dc3 **Type Annotation** ```roc Char ``` **Description** The ASCII "Device Control 3/XOFF" (␓) control character #### dc4 **Type Annotation** ```roc Char ``` **Description** The ASCII "Device Control 4" (␔) control character #### nak **Type Annotation** ```roc Char ``` **Description** The ASCII "Negative Acknowledgement" (␕) control character #### syn **Type Annotation** ```roc Char ``` **Description** The ASCII "Synchronous Idle" (␖) control character #### etb **Type Annotation** ```roc Char ``` **Description** The ASCII "End of Transmission Block" (␗) control character #### can **Type Annotation** ```roc Char ``` **Description** The ASCII "Cancel" (␘) control character #### em **Type Annotation** ```roc Char ``` **Description** The ASCII "End of Medium" (␙) control character #### sub **Type Annotation** ```roc Char ``` **Description** The ASCII "Substitute" (␚) control character #### esc **Type Annotation** ```roc Char ``` **Description** The ASCII "Escape" (␛) control character #### fs **Type Annotation** ```roc Char ``` **Description** The ASCII "File Separator" (␜) control character #### gs **Type Annotation** ```roc Char ``` **Description** The ASCII "Group Separator" (␝) control character #### rs **Type Annotation** ```roc Char ``` **Description** The ASCII "Record Separator" (␞) control character #### us **Type Annotation** ```roc Char ``` **Description** The ASCII "Unit Separator" (␟) control character #### del **Type Annotation** ```roc Char ``` **Description** The ASCII "Delete" (␡) control character