#[repr(u8)]pub enum Char {
Show 128 variants
Null = 0,
StartOfHeading = 1,
StartOfText = 2,
EndOfText = 3,
EndOfTransmission = 4,
Enquiry = 5,
Acknowledge = 6,
Bell = 7,
Backspace = 8,
CharacterTabulation = 9,
LineFeed = 10,
LineTabulation = 11,
FormFeed = 12,
CarriageReturn = 13,
ShiftOut = 14,
ShiftIn = 15,
DataLinkEscape = 16,
DeviceControlOne = 17,
DeviceControlTwo = 18,
DeviceControlThree = 19,
DeviceControlFour = 20,
NegativeAcknowledge = 21,
SynchronousIdle = 22,
EndOfTransmissionBlock = 23,
Cancel = 24,
EndOfMedium = 25,
Substitute = 26,
Escape = 27,
InformationSeparatorFour = 28,
InformationSeparatorThree = 29,
InformationSeparatorTwo = 30,
InformationSeparatorOne = 31,
Space = 32,
ExclamationMark = 33,
QuotationMark = 34,
NumberSign = 35,
DollarSign = 36,
PercentSign = 37,
Ampersand = 38,
Apostrophe = 39,
LeftParenthesis = 40,
RightParenthesis = 41,
Asterisk = 42,
PlusSign = 43,
Comma = 44,
HyphenMinus = 45,
FullStop = 46,
Solidus = 47,
Digit0 = 48,
Digit1 = 49,
Digit2 = 50,
Digit3 = 51,
Digit4 = 52,
Digit5 = 53,
Digit6 = 54,
Digit7 = 55,
Digit8 = 56,
Digit9 = 57,
Colon = 58,
Semicolon = 59,
LessThanSign = 60,
EqualsSign = 61,
GreaterThanSign = 62,
QuestionMark = 63,
CommercialAt = 64,
CapitalA = 65,
CapitalB = 66,
CapitalC = 67,
CapitalD = 68,
CapitalE = 69,
CapitalF = 70,
CapitalG = 71,
CapitalH = 72,
CapitalI = 73,
CapitalJ = 74,
CapitalK = 75,
CapitalL = 76,
CapitalM = 77,
CapitalN = 78,
CapitalO = 79,
CapitalP = 80,
CapitalQ = 81,
CapitalR = 82,
CapitalS = 83,
CapitalT = 84,
CapitalU = 85,
CapitalV = 86,
CapitalW = 87,
CapitalX = 88,
CapitalY = 89,
CapitalZ = 90,
LeftSquareBracket = 91,
ReverseSolidus = 92,
RightSquareBracket = 93,
CircumflexAccent = 94,
LowLine = 95,
GraveAccent = 96,
SmallA = 97,
SmallB = 98,
SmallC = 99,
SmallD = 100,
SmallE = 101,
SmallF = 102,
SmallG = 103,
SmallH = 104,
SmallI = 105,
SmallJ = 106,
SmallK = 107,
SmallL = 108,
SmallM = 109,
SmallN = 110,
SmallO = 111,
SmallP = 112,
SmallQ = 113,
SmallR = 114,
SmallS = 115,
SmallT = 116,
SmallU = 117,
SmallV = 118,
SmallW = 119,
SmallX = 120,
SmallY = 121,
SmallZ = 122,
LeftCurlyBracket = 123,
VerticalLine = 124,
RightCurlyBracket = 125,
Tilde = 126,
Delete = 127,
}
ascii_char
#110998)Expand description
One of the 128 Unicode characters from U+0000 through U+007F, often known as the ASCII subset.
Officially, this is the first block in Unicode, Basic Latin. For details, see the C0 Controls and Basic Latin code chart.
This block was based on older 7-bit character code standards such as ANSI X3.4-1977, ISO 646-1973, and NIST FIPS 1-2.
§When to use this
The main advantage of this subset is that it’s always valid UTF-8. As such,
the &[ascii::Char]
-> &str
conversion function (as well as other related
ones) are O(1): no runtime checks are needed.
If you’re consuming strings, you should usually handle Unicode and thus
accept str
s, not limit yourself to ascii::Char
s.
However, certain formats are intentionally designed to produce ASCII-only
output in order to be 8-bit-clean. In those cases, it can be simpler and
faster to generate ascii::Char
s instead of dealing with the variable width
properties of general UTF-8 encoded strings, while still allowing the result
to be used freely with other Rust things that deal in general str
s.
For example, a UUID library might offer a way to produce the string
representation of a UUID as an [ascii::Char; 36]
to avoid memory
allocation yet still allow it to be used as UTF-8 via as_str
without
paying for validation (or needing unsafe
code) the way it would if it
were provided as a [u8; 36]
.
§Layout
This type is guaranteed to have a size and alignment of 1 byte.
§Names
The variants on this type are Unicode names of the characters in upper camel case, with a few tweaks:
- For
<control>
characters, the primary alias name is used. LATIN
is dropped, as this block has no non-latin letters.LETTER
is dropped, asCAPITAL
/SMALL
suffices in this block.DIGIT
s use a single digit rather than writing outZERO
,ONE
, etc.
Variants§
Null = 0
ascii_char_variants
#110998)U+0000
StartOfHeading = 1
ascii_char_variants
#110998)U+0001
StartOfText = 2
ascii_char_variants
#110998)U+0002
EndOfText = 3
ascii_char_variants
#110998)U+0003
EndOfTransmission = 4
ascii_char_variants
#110998)U+0004
Enquiry = 5
ascii_char_variants
#110998)U+0005
Acknowledge = 6
ascii_char_variants
#110998)U+0006
Bell = 7
ascii_char_variants
#110998)U+0007
Backspace = 8
ascii_char_variants
#110998)U+0008
CharacterTabulation = 9
ascii_char_variants
#110998)U+0009
LineFeed = 10
ascii_char_variants
#110998)U+000A
LineTabulation = 11
ascii_char_variants
#110998)U+000B
FormFeed = 12
ascii_char_variants
#110998)U+000C
CarriageReturn = 13
ascii_char_variants
#110998)U+000D
ShiftOut = 14
ascii_char_variants
#110998)U+000E
ShiftIn = 15
ascii_char_variants
#110998)U+000F
DataLinkEscape = 16
ascii_char_variants
#110998)U+0010
DeviceControlOne = 17
ascii_char_variants
#110998)U+0011
DeviceControlTwo = 18
ascii_char_variants
#110998)U+0012
DeviceControlThree = 19
ascii_char_variants
#110998)U+0013
DeviceControlFour = 20
ascii_char_variants
#110998)U+0014
NegativeAcknowledge = 21
ascii_char_variants
#110998)U+0015
SynchronousIdle = 22
ascii_char_variants
#110998)U+0016
EndOfTransmissionBlock = 23
ascii_char_variants
#110998)U+0017
Cancel = 24
ascii_char_variants
#110998)U+0018
EndOfMedium = 25
ascii_char_variants
#110998)U+0019
Substitute = 26
ascii_char_variants
#110998)U+001A
Escape = 27
ascii_char_variants
#110998)U+001B
InformationSeparatorFour = 28
ascii_char_variants
#110998)U+001C
InformationSeparatorThree = 29
ascii_char_variants
#110998)U+001D
InformationSeparatorTwo = 30
ascii_char_variants
#110998)U+001E
InformationSeparatorOne = 31
ascii_char_variants
#110998)U+001F
Space = 32
ascii_char_variants
#110998)U+0020
ExclamationMark = 33
ascii_char_variants
#110998)U+0021
QuotationMark = 34
ascii_char_variants
#110998)U+0022
NumberSign = 35
ascii_char_variants
#110998)U+0023
DollarSign = 36
ascii_char_variants
#110998)U+0024
PercentSign = 37
ascii_char_variants
#110998)U+0025
Ampersand = 38
ascii_char_variants
#110998)U+0026
Apostrophe = 39
ascii_char_variants
#110998)U+0027
LeftParenthesis = 40
ascii_char_variants
#110998)U+0028
RightParenthesis = 41
ascii_char_variants
#110998)U+0029
Asterisk = 42
ascii_char_variants
#110998)U+002A
PlusSign = 43
ascii_char_variants
#110998)U+002B
Comma = 44
ascii_char_variants
#110998)U+002C
HyphenMinus = 45
ascii_char_variants
#110998)U+002D
FullStop = 46
ascii_char_variants
#110998)U+002E
Solidus = 47
ascii_char_variants
#110998)U+002F
Digit0 = 48
ascii_char_variants
#110998)U+0030
Digit1 = 49
ascii_char_variants
#110998)U+0031
Digit2 = 50
ascii_char_variants
#110998)U+0032
Digit3 = 51
ascii_char_variants
#110998)U+0033
Digit4 = 52
ascii_char_variants
#110998)U+0034
Digit5 = 53
ascii_char_variants
#110998)U+0035
Digit6 = 54
ascii_char_variants
#110998)U+0036
Digit7 = 55
ascii_char_variants
#110998)U+0037
Digit8 = 56
ascii_char_variants
#110998)U+0038
Digit9 = 57
ascii_char_variants
#110998)U+0039
Colon = 58
ascii_char_variants
#110998)U+003A
Semicolon = 59
ascii_char_variants
#110998)U+003B
LessThanSign = 60
ascii_char_variants
#110998)U+003C
EqualsSign = 61
ascii_char_variants
#110998)U+003D
GreaterThanSign = 62
ascii_char_variants
#110998)U+003E
QuestionMark = 63
ascii_char_variants
#110998)U+003F
CommercialAt = 64
ascii_char_variants
#110998)U+0040
CapitalA = 65
ascii_char_variants
#110998)U+0041
CapitalB = 66
ascii_char_variants
#110998)U+0042
CapitalC = 67
ascii_char_variants
#110998)U+0043
CapitalD = 68
ascii_char_variants
#110998)U+0044
CapitalE = 69
ascii_char_variants
#110998)U+0045
CapitalF = 70
ascii_char_variants
#110998)U+0046
CapitalG = 71
ascii_char_variants
#110998)U+0047
CapitalH = 72
ascii_char_variants
#110998)U+0048
CapitalI = 73
ascii_char_variants
#110998)U+0049
CapitalJ = 74
ascii_char_variants
#110998)U+004A
CapitalK = 75
ascii_char_variants
#110998)U+004B
CapitalL = 76
ascii_char_variants
#110998)U+004C
CapitalM = 77
ascii_char_variants
#110998)U+004D
CapitalN = 78
ascii_char_variants
#110998)U+004E
CapitalO = 79
ascii_char_variants
#110998)U+004F
CapitalP = 80
ascii_char_variants
#110998)U+0050
CapitalQ = 81
ascii_char_variants
#110998)U+0051
CapitalR = 82
ascii_char_variants
#110998)U+0052
CapitalS = 83
ascii_char_variants
#110998)U+0053
CapitalT = 84
ascii_char_variants
#110998)U+0054
CapitalU = 85
ascii_char_variants
#110998)U+0055
CapitalV = 86
ascii_char_variants
#110998)U+0056
CapitalW = 87
ascii_char_variants
#110998)U+0057
CapitalX = 88
ascii_char_variants
#110998)U+0058
CapitalY = 89
ascii_char_variants
#110998)U+0059
CapitalZ = 90
ascii_char_variants
#110998)U+005A
LeftSquareBracket = 91
ascii_char_variants
#110998)U+005B
ReverseSolidus = 92
ascii_char_variants
#110998)U+005C
RightSquareBracket = 93
ascii_char_variants
#110998)U+005D
CircumflexAccent = 94
ascii_char_variants
#110998)U+005E
LowLine = 95
ascii_char_variants
#110998)U+005F
GraveAccent = 96
ascii_char_variants
#110998)U+0060
SmallA = 97
ascii_char_variants
#110998)U+0061
SmallB = 98
ascii_char_variants
#110998)U+0062
SmallC = 99
ascii_char_variants
#110998)U+0063
SmallD = 100
ascii_char_variants
#110998)U+0064
SmallE = 101
ascii_char_variants
#110998)U+0065
SmallF = 102
ascii_char_variants
#110998)U+0066
SmallG = 103
ascii_char_variants
#110998)U+0067
SmallH = 104
ascii_char_variants
#110998)U+0068
SmallI = 105
ascii_char_variants
#110998)U+0069
SmallJ = 106
ascii_char_variants
#110998)U+006A
SmallK = 107
ascii_char_variants
#110998)U+006B
SmallL = 108
ascii_char_variants
#110998)U+006C
SmallM = 109
ascii_char_variants
#110998)U+006D
SmallN = 110
ascii_char_variants
#110998)U+006E
SmallO = 111
ascii_char_variants
#110998)U+006F
SmallP = 112
ascii_char_variants
#110998)U+0070
SmallQ = 113
ascii_char_variants
#110998)U+0071
SmallR = 114
ascii_char_variants
#110998)U+0072
SmallS = 115
ascii_char_variants
#110998)U+0073
SmallT = 116
ascii_char_variants
#110998)U+0074
SmallU = 117
ascii_char_variants
#110998)U+0075
SmallV = 118
ascii_char_variants
#110998)U+0076
SmallW = 119
ascii_char_variants
#110998)U+0077
SmallX = 120
ascii_char_variants
#110998)U+0078
SmallY = 121
ascii_char_variants
#110998)U+0079
SmallZ = 122
ascii_char_variants
#110998)U+007A
LeftCurlyBracket = 123
ascii_char_variants
#110998)U+007B
VerticalLine = 124
ascii_char_variants
#110998)U+007C
RightCurlyBracket = 125
ascii_char_variants
#110998)U+007D
Tilde = 126
ascii_char_variants
#110998)U+007E
Delete = 127
ascii_char_variants
#110998)U+007F
Implementations§
source§impl AsciiChar
impl AsciiChar
sourcepub const fn from_u8(b: u8) -> Option<AsciiChar>
🔬This is a nightly-only experimental API. (ascii_char
#110998)
pub const fn from_u8(b: u8) -> Option<AsciiChar>
ascii_char
#110998)Creates an ascii character from the byte b
,
or returns None
if it’s too large.
sourcepub const unsafe fn from_u8_unchecked(b: u8) -> AsciiChar
🔬This is a nightly-only experimental API. (ascii_char
#110998)
pub const unsafe fn from_u8_unchecked(b: u8) -> AsciiChar
ascii_char
#110998)Creates an ASCII character from the byte b
,
without checking whether it’s valid.
§Safety
b
must be in 0..=127
, or else this is UB.
sourcepub const fn digit(d: u8) -> Option<AsciiChar>
🔬This is a nightly-only experimental API. (ascii_char
#110998)
pub const fn digit(d: u8) -> Option<AsciiChar>
ascii_char
#110998)When passed the number 0
, 1
, …, 9
, returns the character
'0'
, '1'
, …, '9'
respectively.
If d >= 10
, returns None
.
sourcepub const unsafe fn digit_unchecked(d: u8) -> AsciiChar
🔬This is a nightly-only experimental API. (ascii_char
#110998)
pub const unsafe fn digit_unchecked(d: u8) -> AsciiChar
ascii_char
#110998)When passed the number 0
, 1
, …, 9
, returns the character
'0'
, '1'
, …, '9'
respectively, without checking that it’s in-range.
§Safety
This is immediate UB if called with d > 64
.
If d >= 10
and d <= 64
, this is allowed to return any value or panic.
Notably, it should not be expected to return hex digits, or any other
reasonable extension of the decimal digits.
(This lose safety condition is intended to simplify soundness proofs when writing code using this method, since the implementation doesn’t need something really specific, not to make those other arguments do something useful. It might be tightened before stabilization.)
sourcepub const fn to_u8(self) -> u8
🔬This is a nightly-only experimental API. (ascii_char
#110998)
pub const fn to_u8(self) -> u8
ascii_char
#110998)Gets this ASCII character as a byte.
Trait Implementations§
source§impl Ord for AsciiChar
impl Ord for AsciiChar
source§impl PartialEq for AsciiChar
impl PartialEq for AsciiChar
source§impl PartialOrd for AsciiChar
impl PartialOrd for AsciiChar
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Step for AsciiChar
impl Step for AsciiChar
source§fn steps_between(_: &AsciiChar, _: &AsciiChar) -> Option<usize>
fn steps_between(_: &AsciiChar, _: &AsciiChar) -> Option<usize>
step_trait
#42168)source§fn forward_checked(start: AsciiChar, count: usize) -> Option<AsciiChar>
fn forward_checked(start: AsciiChar, count: usize) -> Option<AsciiChar>
step_trait
#42168)source§fn backward_checked(start: AsciiChar, count: usize) -> Option<AsciiChar>
fn backward_checked(start: AsciiChar, count: usize) -> Option<AsciiChar>
step_trait
#42168)source§unsafe fn forward_unchecked(start: AsciiChar, count: usize) -> AsciiChar
unsafe fn forward_unchecked(start: AsciiChar, count: usize) -> AsciiChar
step_trait
#42168)source§unsafe fn backward_unchecked(start: AsciiChar, count: usize) -> AsciiChar
unsafe fn backward_unchecked(start: AsciiChar, count: usize) -> AsciiChar
step_trait
#42168)