Struct ascii::AsciiStr
[−]
[src]
pub struct AsciiStr { /* fields omitted */ }
AsciiStr represents a byte or string slice that only contains ASCII characters.
It wraps an [AsciiChar]
and implements many of str
s methods and traits.
It can be created by a checked conversion from a str
or [u8]
, or borrowed from an
AsciiString
.
Methods
impl AsciiStr
[src]
pub fn new<S: AsRef<AsciiStr> + ?Sized>(s: &S) -> &AsciiStr
[src]
Coerces into an AsciiStr
slice.
pub fn as_str(&self) -> &str
[src]
Converts &self
to a &str
slice.
pub fn as_bytes(&self) -> &[u8]
[src]
Converts &self
into a byte slice.
pub fn as_slice(&self) -> &[AsciiChar]
[src]
Returns the entire string as slice of AsciiChar
s.
pub fn as_mut_slice(&mut self) -> &mut [AsciiChar]
[src]
Returns the entire string as mutable slice of AsciiChar
s.
pub fn as_ptr(&self) -> *const AsciiChar
[src]
Returns a raw pointer to the AsciiStr
's buffer.
The caller must ensure that the slice outlives the pointer this function returns, or else it
will end up pointing to garbage. Modifying the AsciiStr
may cause it's buffer to be
reallocated, which would also make any pointers to it invalid.
pub fn as_mut_ptr(&mut self) -> *mut AsciiChar
[src]
Returns an unsafe mutable pointer to the AsciiStr
's buffer.
The caller must ensure that the slice outlives the pointer this function returns, or else it
will end up pointing to garbage. Modifying the AsciiStr
may cause it's buffer to be
reallocated, which would also make any pointers to it invalid.
pub fn to_ascii_string(&self) -> AsciiString
[src]
Copies the content of this AsciiStr
into an owned AsciiString
.
pub fn from_ascii<B: ?Sized>(bytes: &B) -> Result<&AsciiStr, AsAsciiStrError> where
B: AsRef<[u8]>,
[src]
B: AsRef<[u8]>,
Converts anything that can represent a byte slice into an AsciiStr
.
Examples
let foo = AsciiStr::from_ascii("foo"); let err = AsciiStr::from_ascii("Ŋ"); assert_eq!(foo.unwrap().as_str(), "foo"); assert_eq!(err.unwrap_err().valid_up_to(), 0);
pub unsafe fn from_ascii_unchecked<B: ?Sized>(bytes: &B) -> &AsciiStr where
B: AsRef<[u8]>,
[src]
B: AsRef<[u8]>,
Converts anything that can be represented as a byte slice to an AsciiStr
without checking
for non-ASCII characters..
Examples
let foo = unsafe{ AsciiStr::from_ascii_unchecked("foo") }; assert_eq!(foo.as_str(), "foo");
pub fn len(&self) -> usize
[src]
Returns the number of characters / bytes in this ASCII sequence.
Examples
let s = AsciiStr::from_ascii("foo").unwrap(); assert_eq!(s.len(), 3);
pub fn is_empty(&self) -> bool
[src]
Returns true if the ASCII slice contains zero bytes.
Examples
let mut empty = AsciiStr::from_ascii("").unwrap(); let mut full = AsciiStr::from_ascii("foo").unwrap(); assert!(empty.is_empty()); assert!(!full.is_empty());
pub fn chars(&self) -> Chars
[src]
Returns an iterator over the characters of the AsciiStr
.
pub fn chars_mut(&mut self) -> CharsMut
[src]
Returns an iterator over the characters of the AsciiStr
which allows you to modify the
value of each AsciiChar
.
ⓘImportant traits for Lines<'a>pub fn lines(&self) -> Lines
[src]
Returns an iterator over the lines of the AsciiStr
, which are themselves AsciiStr
s.
Lines are ended with either LineFeed
(\n
), or CarriageReturn
then LineFeed
(\r\n
).
The final line ending is optional.
pub fn trim(&self) -> &Self
[src]
Returns an ASCII string slice with leading and trailing whitespace removed.
Examples
let example = AsciiStr::from_ascii(" \twhite \tspace \t").unwrap(); assert_eq!("white \tspace", example.trim());
pub fn trim_left(&self) -> &Self
[src]
Returns an ASCII string slice with leading whitespace removed.
Examples
let example = AsciiStr::from_ascii(" \twhite \tspace \t").unwrap(); assert_eq!("white \tspace \t", example.trim_left());
pub fn trim_right(&self) -> &Self
[src]
Returns an ASCII string slice with trailing whitespace removed.
Examples
let example = AsciiStr::from_ascii(" \twhite \tspace \t").unwrap(); assert_eq!(" \twhite \tspace", example.trim_right());
pub fn eq_ignore_ascii_case(&self, other: &Self) -> bool
[src]
Compares two strings case-insensitively.
pub fn make_ascii_uppercase(&mut self)
[src]
Replaces lowercase letters with their uppercase equivalent.
pub fn make_ascii_lowercase(&mut self)
[src]
Replaces uppercase letters with their lowercase equivalent.
pub fn to_ascii_uppercase(&self) -> AsciiString
[src]
Returns a copy of this string where letters 'a' to 'z' are mapped to 'A' to 'Z'.
pub fn to_ascii_lowercase(&self) -> AsciiString
[src]
Returns a copy of this string where letters 'A' to 'Z' are mapped to 'a' to 'z'.
Trait Implementations
impl PartialEq for AsciiStr
[src]
fn eq(&self, __arg_0: &AsciiStr) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &AsciiStr) -> bool
[src]
This method tests for !=
.
impl Eq for AsciiStr
[src]
impl PartialOrd for AsciiStr
[src]
fn partial_cmp(&self, __arg_0: &AsciiStr) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &AsciiStr) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &AsciiStr) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &AsciiStr) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &AsciiStr) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for AsciiStr
[src]
fn cmp(&self, __arg_0: &AsciiStr) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Hash for AsciiStr
[src]
fn hash<__H: Hasher>(&self, __arg_0: &mut __H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl PartialEq<str> for AsciiStr
[src]
fn eq(&self, other: &str) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl PartialEq<AsciiStr> for str
[src]
fn eq(&self, other: &AsciiStr) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &Rhs) -> bool
1.0.0[src]
This method tests for !=
.
impl ToOwned for AsciiStr
[src]
type Owned = AsciiString
fn to_owned(&self) -> AsciiString
[src]
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut Self::Owned)
[src]
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl AsRef<[u8]> for AsciiStr
[src]
impl AsRef<str> for AsciiStr
[src]
impl AsRef<[AsciiChar]> for AsciiStr
[src]
impl AsMut<[AsciiChar]> for AsciiStr
[src]
impl Default for &'static AsciiStr
[src]
impl<'a> From<&'a [AsciiChar]> for &'a AsciiStr
[src]
impl<'a> From<&'a mut [AsciiChar]> for &'a mut AsciiStr
[src]
impl<'a> From<&'a AsciiStr> for &'a [AsciiChar]
[src]
impl<'a> From<&'a mut AsciiStr> for &'a mut [AsciiChar]
[src]
impl<'a> From<&'a AsciiStr> for &'a [u8]
[src]
impl<'a> From<&'a mut AsciiStr> for &'a mut [u8]
[src]
impl<'a> From<&'a AsciiStr> for &'a str
[src]
impl<'a> From<&'a mut AsciiStr> for &'a mut str
[src]
impl Display for AsciiStr
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Debug for AsciiStr
[src]
fn fmt(&self, f: &mut Formatter) -> Result
[src]
Formats the value using the given formatter. Read more
impl Index<Range<usize>> for AsciiStr
[src]
type Output = AsciiStr
The returned type after indexing.
fn index(&self, index: Range<usize>) -> &AsciiStr
[src]
Performs the indexing (container[index]
) operation.
impl IndexMut<Range<usize>> for AsciiStr
[src]
fn index_mut(&mut self, index: Range<usize>) -> &mut AsciiStr
[src]
Performs the mutable indexing (container[index]
) operation.
impl Index<RangeTo<usize>> for AsciiStr
[src]
type Output = AsciiStr
The returned type after indexing.
fn index(&self, index: RangeTo<usize>) -> &AsciiStr
[src]
Performs the indexing (container[index]
) operation.
impl IndexMut<RangeTo<usize>> for AsciiStr
[src]
fn index_mut(&mut self, index: RangeTo<usize>) -> &mut AsciiStr
[src]
Performs the mutable indexing (container[index]
) operation.
impl Index<RangeFrom<usize>> for AsciiStr
[src]
type Output = AsciiStr
The returned type after indexing.
fn index(&self, index: RangeFrom<usize>) -> &AsciiStr
[src]
Performs the indexing (container[index]
) operation.
impl IndexMut<RangeFrom<usize>> for AsciiStr
[src]
fn index_mut(&mut self, index: RangeFrom<usize>) -> &mut AsciiStr
[src]
Performs the mutable indexing (container[index]
) operation.
impl Index<RangeFull> for AsciiStr
[src]
type Output = AsciiStr
The returned type after indexing.
fn index(&self, index: RangeFull) -> &AsciiStr
[src]
Performs the indexing (container[index]
) operation.
impl IndexMut<RangeFull> for AsciiStr
[src]
fn index_mut(&mut self, index: RangeFull) -> &mut AsciiStr
[src]
Performs the mutable indexing (container[index]
) operation.
impl Index<usize> for AsciiStr
[src]
type Output = AsciiChar
The returned type after indexing.
fn index(&self, index: usize) -> &AsciiChar
[src]
Performs the indexing (container[index]
) operation.
impl IndexMut<usize> for AsciiStr
[src]
fn index_mut(&mut self, index: usize) -> &mut AsciiChar
[src]
Performs the mutable indexing (container[index]
) operation.
impl AsciiExt for AsciiStr
[src]
type Owned = AsciiString
Container type for copied ASCII characters.
fn is_ascii(&self) -> bool
[src]
Checks if the value is within the ASCII range. Read more
fn to_ascii_uppercase(&self) -> AsciiString
[src]
Makes a copy of the value in its ASCII upper case equivalent. Read more
fn to_ascii_lowercase(&self) -> AsciiString
[src]
Makes a copy of the value in its ASCII lower case equivalent. Read more
fn eq_ignore_ascii_case(&self, other: &Self) -> bool
[src]
Checks that two values are an ASCII case-insensitive match. Read more
fn make_ascii_uppercase(&mut self)
[src]
Converts this type to its ASCII upper case equivalent in-place. Read more
fn make_ascii_lowercase(&mut self)
[src]
Converts this type to its ASCII lower case equivalent in-place. Read more
fn is_ascii_alphabetic(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII alphabetic character: U+0041 'A' ... U+005A 'Z' or U+0061 'a' ... U+007A 'z'. For strings, true if all characters in the string are ASCII alphabetic. Read more
fn is_ascii_uppercase(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII uppercase character: U+0041 'A' ... U+005A 'Z'. For strings, true if all characters in the string are ASCII uppercase. Read more
fn is_ascii_lowercase(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII lowercase character: U+0061 'a' ... U+007A 'z'. For strings, true if all characters in the string are ASCII lowercase. Read more
fn is_ascii_alphanumeric(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII alphanumeric character: U+0041 'A' ... U+005A 'Z', U+0061 'a' ... U+007A 'z', or U+0030 '0' ... U+0039 '9'. For strings, true if all characters in the string are ASCII alphanumeric. Read more
fn is_ascii_digit(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII decimal digit: U+0030 '0' ... U+0039 '9'. For strings, true if all characters in the string are ASCII digits. Read more
fn is_ascii_hexdigit(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII hexadecimal digit: U+0030 '0' ... U+0039 '9', U+0041 'A' ... U+0046 'F', or U+0061 'a' ... U+0066 'f'. For strings, true if all characters in the string are ASCII hex digits. Read more
fn is_ascii_punctuation(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII punctuation character: Read more
fn is_ascii_graphic(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII graphic character: U+0021 '!' ... U+007E '~'. For strings, true if all characters in the string are ASCII graphic characters. Read more
fn is_ascii_whitespace(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII whitespace character: U+0020 SPACE, U+0009 HORIZONTAL TAB, U+000A LINE FEED, U+000C FORM FEED, or U+000D CARRIAGE RETURN. For strings, true if all characters in the string are ASCII whitespace. Read more
fn is_ascii_control(&self) -> bool
[src]
ascii_ctype
)Checks if the value is an ASCII control character: U+0000 NUL ... U+001F UNIT SEPARATOR, or U+007F DELETE. Note that most ASCII whitespace characters are control characters, but SPACE is not. Read more
impl<'a> IntoIterator for &'a AsciiStr
[src]
type Item = &'a AsciiChar
The type of the elements being iterated over.
type IntoIter = Chars<'a>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
Creates an iterator from a value. Read more
impl<'a> IntoIterator for &'a mut AsciiStr
[src]
type Item = &'a mut AsciiChar
The type of the elements being iterated over.
type IntoIter = CharsMut<'a>
Which kind of iterator are we turning this into?
fn into_iter(self) -> Self::IntoIter
[src]
Creates an iterator from a value. Read more
impl AsAsciiStr for AsciiStr
[src]
fn as_ascii_str(&self) -> Result<&AsciiStr, AsAsciiStrError>
[src]
Convert to an ASCII slice.
unsafe fn as_ascii_str_unchecked(&self) -> &AsciiStr
[src]
Convert to an ASCII slice without checking for non-ASCII characters.
impl AsMutAsciiStr for AsciiStr
[src]
fn as_mut_ascii_str(&mut self) -> Result<&mut AsciiStr, AsAsciiStrError>
[src]
Convert to a mutable ASCII slice.
unsafe fn as_mut_ascii_str_unchecked(&mut self) -> &mut AsciiStr
[src]
Convert to a mutable ASCII slice without checking for non-ASCII characters.
impl<'a> PartialEq<String> for &'a AsciiStr
[src]
fn eq(&self, other: &String) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &String) -> bool
[src]
This method tests for !=
.
impl<'a> PartialEq<&'a AsciiStr> for String
[src]
fn eq(&self, other: &&'a AsciiStr) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &&'a AsciiStr) -> bool
[src]
This method tests for !=
.
impl<'a> PartialEq<AsciiString> for &'a AsciiStr
[src]
fn eq(&self, other: &AsciiString) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &AsciiString) -> bool
[src]
This method tests for !=
.
impl<'a> PartialEq<&'a AsciiStr> for AsciiString
[src]
fn eq(&self, other: &&'a AsciiStr) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &&'a AsciiStr) -> bool
[src]
This method tests for !=
.
impl Borrow<AsciiStr> for AsciiString
[src]
impl AsRef<AsciiStr> for AsciiString
[src]
impl AsMut<AsciiStr> for AsciiString
[src]
impl<'a> FromIterator<&'a AsciiStr> for AsciiString
[src]
fn from_iter<I: IntoIterator<Item = &'a AsciiStr>>(iter: I) -> AsciiString
[src]
Creates a value from an iterator. Read more
impl<'a> Extend<&'a AsciiStr> for AsciiString
[src]
fn extend<I: IntoIterator<Item = &'a AsciiStr>>(&mut self, iterable: I)
[src]
Extends a collection with the contents of an iterator. Read more
impl<'a> Add<&'a AsciiStr> for AsciiString
[src]
type Output = AsciiString
The resulting type after applying the +
operator.
fn add(self, other: &AsciiStr) -> AsciiString
[src]
Performs the +
operation.