Skip to main content

Ascii

qubit_text_codec

Enum Ascii

pub enum Ascii {}

Expand description

Namespace for ASCII character and code point helpers.

Implementations§

impl Ascii

pub const MAX_CHAR: char = '\u{007f}'

Maximum valid ASCII character.

pub const MAX_BYTE: u8

Maximum valid ASCII byte.

pub const MAX_FOLDING_COUNT: usize = 4

Maximum number of ASCII characters emitted by Self::fold.

pub const NULL_CHAR: char = '\0'

ASCII NUL.

pub const NULL_BYTE: u8

ASCII NUL as a byte.

pub const START_OF_HEADER_CHAR: char = '\u{0001}'

ASCII SOH.

pub const START_OF_HEADER_BYTE: u8

ASCII SOH as a byte.

pub const START_OF_TEXT_CHAR: char = '\u{0002}'

ASCII STX.

pub const START_OF_TEXT_BYTE: u8

ASCII STX as a byte.

pub const END_OF_TEXT_CHAR: char = '\u{0003}'

ASCII ETX.

pub const END_OF_TEXT_BYTE: u8

ASCII ETX as a byte.

pub const START_OF_TRANSMISSION_CHAR: char = '\u{0004}'

ASCII EOT.

pub const START_OF_TRANSMISSION_BYTE: u8

ASCII EOT as a byte.

pub const ENQUIRY_CHAR: char = '\u{0005}'

ASCII ENQ.

pub const ENQUIRY_BYTE: u8

ASCII ENQ as a byte.

pub const ACKNOWLEDGMENT_CHAR: char = '\u{0006}'

ASCII ACK.

pub const ACKNOWLEDGMENT_BYTE: u8

ASCII ACK as a byte.

pub const BELL_CHAR: char = '\u{0007}'

ASCII BEL.

pub const BELL_BYTE: u8

ASCII BEL as a byte.

pub const BACKSPACE_CHAR: char = '\u{0008}'

ASCII BS.

pub const BACKSPACE_BYTE: u8

ASCII BS as a byte.

pub const HORIZONTAL_TAB_CHAR: char = '\t'

ASCII HT.

pub const HORIZONTAL_TAB_BYTE: u8

ASCII HT as a byte.

pub const LINE_FEED_CHAR: char = '\n'

ASCII LF.

pub const LINE_FEED_BYTE: u8

ASCII LF as a byte.

pub const VERTICAL_TAB_CHAR: char = '\u{000b}'

ASCII VT.

pub const VERTICAL_TAB_BYTE: u8

ASCII VT as a byte.

pub const FORM_FEED_CHAR: char = '\u{000c}'

ASCII FF.

pub const FORM_FEED_BYTE: u8

ASCII FF as a byte.

pub const CARRIAGE_RETURN_CHAR: char = '\r'

ASCII CR.

pub const CARRIAGE_RETURN_BYTE: u8

ASCII CR as a byte.

pub const SHIFT_OUT_CHAR: char = '\u{000e}'

ASCII SO.

pub const SHIFT_OUT_BYTE: u8

ASCII SO as a byte.

pub const SHIFT_IN_CHAR: char = '\u{000f}'

ASCII SI.

pub const SHIFT_IN_BYTE: u8

ASCII SI as a byte.

pub const DATA_LINK_ESCAPE_CHAR: char = '\u{0010}'

ASCII DLE.

pub const DATA_LINK_ESCAPE_BYTE: u8

ASCII DLE as a byte.

pub const DEVICE_CONTROL_1_CHAR: char = '\u{0011}'

ASCII DC1.

pub const DEVICE_CONTROL_1_BYTE: u8

ASCII DC1 as a byte.

pub const DEVICE_CONTROL_2_CHAR: char = '\u{0012}'

ASCII DC2.

pub const DEVICE_CONTROL_2_BYTE: u8

ASCII DC2 as a byte.

pub const DEVICE_CONTROL_3_CHAR: char = '\u{0013}'

ASCII DC3.

pub const DEVICE_CONTROL_3_BYTE: u8

ASCII DC3 as a byte.

pub const DEVICE_CONTROL_4_CHAR: char = '\u{0014}'

ASCII DC4.

pub const DEVICE_CONTROL_4_BYTE: u8

ASCII DC4 as a byte.

pub const NEGATIVE_ACKNOWLEDGEMENT_CHAR: char = '\u{0015}'

ASCII NAK.

pub const NEGATIVE_ACKNOWLEDGEMENT_BYTE: u8

ASCII NAK as a byte.

pub const SYNCHRONOUS_IDLE_CHAR: char = '\u{0016}'

ASCII SYN.

pub const SYNCHRONOUS_IDLE_BYTE: u8

ASCII SYN as a byte.

pub const END_OF_TRANS_BLOCK_CHAR: char = '\u{0017}'

ASCII ETB.

pub const END_OF_TRANS_BLOCK_BYTE: u8

ASCII ETB as a byte.

pub const CANCEL_CHAR: char = '\u{0018}'

ASCII CAN.

pub const CANCEL_BYTE: u8

ASCII CAN as a byte.

pub const END_OF_MEDIUM_CHAR: char = '\u{0019}'

ASCII EM.

pub const END_OF_MEDIUM_BYTE: u8

ASCII EM as a byte.

pub const SUBSTITUTE_CHAR: char = '\u{001a}'

ASCII SUB.

pub const SUBSTITUTE_BYTE: u8

ASCII SUB as a byte.

pub const ESCAPE_CHAR: char = '\u{001b}'

ASCII ESC.

pub const ESCAPE_BYTE: u8

ASCII ESC as a byte.

pub const FILE_SEPARATOR_CHAR: char = '\u{001c}'

ASCII FS.

pub const FILE_SEPARATOR_BYTE: u8

ASCII FS as a byte.

pub const GROUP_SEPARATOR_CHAR: char = '\u{001d}'

ASCII GS.

pub const GROUP_SEPARATOR_BYTE: u8

ASCII GS as a byte.

pub const RECORD_SEPARATOR_CHAR: char = '\u{001e}'

ASCII RS.

pub const RECORD_SEPARATOR_BYTE: u8

ASCII RS as a byte.

pub const UNIT_SEPARATOR_CHAR: char = '\u{001f}'

ASCII US.

pub const UNIT_SEPARATOR_BYTE: u8

ASCII US as a byte.

pub const DELETE_CHAR: char = '\u{007f}'

ASCII DEL.

pub const DELETE_BYTE: u8

ASCII DEL as a byte.

pub const SPACE_CHAR: char = ' '

ASCII space.

pub const SPACE_BYTE: u8

ASCII space as a byte.

pub const EXCLAMATION_CHAR: char = '!'

ASCII exclamation mark.

pub const EXCLAMATION_BYTE: u8

ASCII exclamation mark as a byte.

pub const DOUBLE_QUOTE_CHAR: char = '"'

ASCII double quote.

pub const DOUBLE_QUOTE_BYTE: u8

ASCII double quote as a byte.

pub const SHARP_CHAR: char = '#'

ASCII number sign.

pub const SHARP_BYTE: u8

ASCII number sign as a byte.

pub const DOLLAR_CHAR: char = '$'

ASCII dollar sign.

pub const DOLLAR_BYTE: u8

ASCII dollar sign as a byte.

pub const PERCENT_CHAR: char = '%'

ASCII percent sign.

pub const PERCENT_BYTE: u8

ASCII percent sign as a byte.

pub const AMPERSAND_CHAR: char = '&'

ASCII ampersand.

pub const AMPERSAND_BYTE: u8

ASCII ampersand as a byte.

pub const TAB_CHAR: char = '\t'

ASCII tab.

pub const TAB_BYTE: u8

ASCII tab as a byte.

pub const BACKSLASH_CHAR: char = '\\'

ASCII backslash.

pub const BACKSLASH_BYTE: u8

ASCII backslash as a byte.

pub const SINGLE_QUOTE_CHAR: char = '\''

ASCII single quote.

pub const SINGLE_QUOTE_BYTE: u8

ASCII single quote as a byte.

pub const BACK_QUOTE_CHAR: char = '`'

ASCII back quote.

pub const BACK_QUOTE_BYTE: u8

ASCII back quote as a byte.

pub const COMMA_CHAR: char = ','

ASCII comma.

pub const COMMA_BYTE: u8

ASCII comma as a byte.

pub const PERIOD_CHAR: char = '.'

ASCII period.

pub const PERIOD_BYTE: u8

ASCII period as a byte.

pub const MIN_PRINTABLE_CHAR: char = ' '

Minimum printable ASCII character.

pub const MIN_PRINTABLE_BYTE: u8

Minimum printable ASCII character as a byte.

pub const MAX_PRINTABLE_CHAR: char = '~'

Maximum printable ASCII character.

pub const MAX_PRINTABLE_BYTE: u8

Maximum printable ASCII character as a byte.

pub const PRINTABLE_CHARS: [char; 95]

All printable ASCII characters.

pub const PRINTABLE_BYTES: [u8; 95]

All printable ASCII characters as bytes.

pub const LETTER_CHARS: [char; 52]

All ASCII letter characters.

pub const LETTER_BYTES: [u8; 52]

All ASCII letter characters as bytes.

pub const LETTER_DIGIT_CHARS: [char; 62]

All ASCII letter and digit characters.

pub const LETTER_DIGIT_BYTES: [u8; 62]

All ASCII letter and digit characters as bytes.

pub const DIGIT_CHARS: [char; 10]

ASCII digit characters.

pub const DIGIT_BYTES: [u8; 10]

ASCII digit bytes.

pub const LOWERCASE_HEX_DIGIT_CHARS: [char; 16]

Lowercase ASCII hexadecimal digit characters.

pub const LOWERCASE_HEX_DIGIT_BYTES: [u8; 16]

Lowercase ASCII hexadecimal digit bytes.

pub const UPPERCASE_HEX_DIGIT_CHARS: [char; 16]

Uppercase ASCII hexadecimal digit characters.

pub const UPPERCASE_HEX_DIGIT_BYTES: [u8; 16]

Uppercase ASCII hexadecimal digit bytes.

pub const fn is_ascii_byte(ch: u8) -> bool

Tests whether a byte is an ASCII byte.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in the ASCII range 0x00..=0x7F.

pub const fn is_ascii_char(ch: char) -> bool

Tests whether a character is an ASCII character.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in the ASCII range U+0000..=U+007F.

pub const fn is_ascii_code_point(ch: u32) -> bool

Tests whether an integer value is an ASCII code point.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in the ASCII range 0x00..=0x7F. Negative values and values above 0x7F return false.

pub const fn is_whitespace_byte(ch: u8) -> bool

Tests whether a byte is Java-style ASCII whitespace.

§Parameters

ch: The byte to test.

§Returns

Returns true for tab, line feed, form feed, carriage return, or space.

pub const fn is_whitespace_char(ch: char) -> bool

Tests whether a character is Java-style ASCII whitespace.

§Parameters

ch: The character to test.

§Returns

Returns true for tab, line feed, form feed, carriage return, or space.

pub const fn is_whitespace_code_point(ch: u32) -> bool

Tests whether a raw code point is Java-style ASCII whitespace.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true for tab, line feed, form feed, carriage return, or space. Other values, including negative values, return false.

pub const fn is_letter_byte(ch: u8) -> bool

Tests whether a byte is an ASCII letter.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in A..=Z or a..=z.

pub const fn is_letter_char(ch: char) -> bool

Tests whether a character is an ASCII letter.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in A..=Z or a..=z.

pub const fn is_letter_code_point(ch: u32) -> bool

Tests whether a raw code point is an ASCII letter.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in A..=Z or a..=z.

pub const fn is_uppercase_letter_byte(ch: u8) -> bool

Tests whether a byte is an uppercase ASCII letter.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in A..=Z.

pub const fn is_uppercase_letter_char(ch: char) -> bool

Tests whether a character is an uppercase ASCII letter.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in A..=Z.

pub const fn is_uppercase_letter_code_point(ch: u32) -> bool

Tests whether a raw code point is an uppercase ASCII letter.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in A..=Z.

pub const fn is_lowercase_letter_byte(ch: u8) -> bool

Tests whether a byte is a lowercase ASCII letter.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in a..=z.

pub const fn is_lowercase_letter_char(ch: char) -> bool

Tests whether a character is a lowercase ASCII letter.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in a..=z.

pub const fn is_lowercase_letter_code_point(ch: u32) -> bool

Tests whether a raw code point is a lowercase ASCII letter.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in a..=z.

pub const fn is_digit_byte(ch: u8) -> bool

Tests whether a byte is an ASCII decimal digit.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in 0..=9.

pub const fn is_digit_char(ch: char) -> bool

Tests whether a character is an ASCII decimal digit.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in 0..=9.

pub const fn is_digit_code_point(ch: u32) -> bool

Tests whether a raw code point is an ASCII decimal digit.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in 0..=9.

pub const fn is_hex_digit_byte(ch: u8) -> bool

Tests whether a byte is an ASCII hexadecimal digit.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in 0..=9, A..=F, or a..=f.

pub const fn is_hex_digit_char(ch: char) -> bool

Tests whether a character is an ASCII hexadecimal digit.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in 0..=9, A..=F, or a..=f.

pub const fn is_hex_digit_code_point(ch: u32) -> bool

Tests whether a raw code point is an ASCII hexadecimal digit.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in 0..=9, A..=F, or a..=f.

pub const fn is_octal_digit_byte(ch: u8) -> bool

Tests whether a byte is an ASCII octal digit.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in 0..=7.

pub const fn is_octal_digit_char(ch: char) -> bool

Tests whether a character is an ASCII octal digit.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in 0..=7.

pub const fn is_octal_digit_code_point(ch: u32) -> bool

Tests whether a raw code point is an ASCII octal digit.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in 0..=7.

pub const fn is_letter_or_digit_byte(ch: u8) -> bool

Tests whether a byte is an ASCII letter or digit.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is an ASCII letter or decimal digit.

pub const fn is_letter_or_digit_char(ch: char) -> bool

Tests whether a character is an ASCII letter or digit.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is an ASCII letter or decimal digit.

pub const fn is_letter_or_digit_code_point(ch: u32) -> bool

Tests whether a raw code point is an ASCII letter or digit.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is an ASCII letter or decimal digit.

pub const fn is_printable_byte(ch: u8) -> bool

Tests whether a byte is a printable ASCII character.

§Parameters

ch: The byte to test.

§Returns

Returns true if ch is in the printable ASCII range 0x20..=0x7E.

pub const fn is_printable_char(ch: char) -> bool

Tests whether a character is a printable ASCII character.

§Parameters

ch: The character to test.

§Returns

Returns true if ch is in the printable ASCII range U+0020..=U+007E.

pub const fn is_printable_code_point(ch: u32) -> bool

Tests whether a raw code point is a printable ASCII character.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true if ch is in the printable ASCII range 0x20..=0x7E.

pub const fn is_control_byte(ch: u8) -> bool

Tests whether a byte is an ASCII control character.

§Parameters

ch: The byte to test.

§Returns

Returns true for 0x00..=0x1F or 0x7F.

pub const fn is_control_char(ch: char) -> bool

Tests whether a character is an ASCII control character.

§Parameters

ch: The character to test.

§Returns

Returns true for U+0000..=U+001F or U+007F.

pub const fn is_control_code_point(ch: u32) -> bool

Tests whether a raw code point is an ASCII control character.

§Parameters

ch: The raw code point value to test.

§Returns

Returns true for 0x00..=0x1F or 0x7F.

pub const fn equals_ignore_case_byte(ch1: u8, ch2: u8) -> bool

Compares two bytes while ignoring ASCII case.

§Parameters

ch1: The first byte to compare.
ch2: The second byte to compare.

§Returns

Returns true if the bytes are equal after converting ASCII uppercase letters to lowercase. Non-ASCII bytes are compared unchanged.

pub const fn equals_ignore_case_char(ch1: char, ch2: char) -> bool

Compares two characters while ignoring ASCII case.

§Parameters

ch1: The first character to compare.
ch2: The second character to compare.

§Returns

Returns true if the characters are equal after converting ASCII uppercase letters to lowercase. Non-ASCII characters are compared unchanged.

pub const fn equals_ignore_case_code_point(ch1: u32, ch2: u32) -> bool

Compares two raw code points while ignoring ASCII case.

§Parameters

ch1: The first raw code point value to compare.
ch2: The second raw code point value to compare.

§Returns

Returns true if the values are equal after converting ASCII uppercase letters to lowercase. Values outside ASCII are compared unchanged.

pub const fn byte_to_uppercase(ch: u8) -> u8

Converts a byte to uppercase using ASCII case rules.

§Parameters

ch: The byte to convert.

§Returns

Returns the uppercase ASCII equivalent for a..=z; all other bytes are returned unchanged.

pub const fn char_to_uppercase(ch: char) -> char

Converts a character to uppercase using ASCII case rules.

§Parameters

ch: The character to convert.

§Returns

Returns the uppercase ASCII equivalent for a..=z; all other characters are returned unchanged.

pub const fn code_point_to_uppercase(ch: u32) -> u32

Converts a raw code point to uppercase using ASCII case rules.

§Parameters

ch: The raw code point value to convert.

§Returns

Returns the uppercase ASCII equivalent for a..=z; all other values are returned unchanged.

pub const fn byte_to_lowercase(ch: u8) -> u8

Converts a byte to lowercase using ASCII case rules.

§Parameters

ch: The byte to convert.

§Returns

Returns the lowercase ASCII equivalent for A..=Z; all other bytes are returned unchanged.

pub const fn char_to_lowercase(ch: char) -> char

Converts a character to lowercase using ASCII case rules.

§Parameters

ch: The character to convert.

§Returns

Returns the lowercase ASCII equivalent for A..=Z; all other characters are returned unchanged.

pub const fn code_point_to_lowercase(ch: u32) -> u32

Converts a raw code point to lowercase using ASCII case rules.

§Parameters

ch: The raw code point value to convert.

§Returns

Returns the lowercase ASCII equivalent for A..=Z; all other values are returned unchanged.

pub const fn byte_to_digit(ch: u8) -> Option<u8>

Converts an ASCII decimal digit byte into its numeric value.

§Parameters

ch: The byte to convert.

§Returns

Returns Some(0..=9) for 0..=9; returns None otherwise.

pub const fn char_to_digit(ch: char) -> Option<u8>

Converts an ASCII decimal digit character into its numeric value.

§Parameters

ch: The character to convert.

§Returns

Returns Some(0..=9) for 0..=9; returns None otherwise.

pub const fn code_point_to_digit(ch: u32) -> Option<u8>

Converts an ASCII decimal digit code point into its numeric value.

§Parameters

ch: The raw code point value to convert.

§Returns

Returns Some(0..=9) for 0..=9; returns None otherwise.

pub const fn byte_to_hex_digit(ch: u8) -> Option<u8>

Converts an ASCII hexadecimal digit byte into its numeric value.

§Parameters

ch: The byte to convert.

§Returns

Returns Some(0..=15) for 0..=9, A..=F, or a..=f; returns None otherwise.

pub const fn char_to_hex_digit(ch: char) -> Option<u8>

Converts an ASCII hexadecimal digit character into its numeric value.

§Parameters

ch: The character to convert.

§Returns

Returns Some(0..=15) for 0..=9, A..=F, or a..=f; returns None otherwise.

pub const fn code_point_to_hex_digit(ch: u32) -> Option<u8>

Converts an ASCII hexadecimal digit code point into its numeric value.

§Parameters

ch: The raw code point value to convert.

§Returns

Returns Some(0..=15) for 0..=9, A..=F, or a..=f; returns None otherwise.

pub fn fold(ch: char, result: &mut [char], offset: usize) -> usize

Folds a Unicode character to its ASCII replacement.

§Parameters

ch: The character to fold.
result: The caller-provided output buffer that receives the folded characters.
offset: The starting index in result at which folded characters are written.

§Returns

Returns the number of characters written to result starting at offset. ASCII characters and unmapped non-ASCII characters write one character. Mapped characters write up to Self::MAX_FOLDING_COUNT ASCII characters.

§Panics

Panics if result has fewer than Self::MAX_FOLDING_COUNT writable slots after offset.

pub fn fold_to_string(ch: char) -> String

Folds a Unicode character into an owned string.

§Parameters

ch: The character to fold.

§Returns

Returns the folded ASCII replacement as a String. If ch has no folding mapping, the returned string contains ch unchanged.

Auto Trait Implementations§

impl Freeze for Ascii

impl RefUnwindSafe for Ascii

impl Send for Ascii

impl Sync for Ascii

impl Unpin for Ascii

impl UnsafeUnpin for Ascii

impl UnwindSafe for Ascii

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.