# Module alloc::str

1.0.0 · source ·
Expand description

Utilities for the `str` primitive type.

See also the `str` primitive type.

## Modules

- pattern Experimental
  The string Pattern API.

## Structs

- Utf8Chunk Experimental
  An item returned by the `Utf8Chunks` iterator.
- Utf8Chunks Experimental
  An iterator used to decode a slice of mostly UTF-8 bytes to string slices (`&str`) and byte slices (`&[u8]`).
- Bytes
  An iterator over the bytes of a string slice.
- CharIndices
  An iterator over the `char`s of a string slice, and their positions.
- Chars
  An iterator over the `char`s of a string slice.
- EncodeUtf16
  An iterator of `u16` over the string encoded as UTF-16.
- EscapeDebug
  The return type of `str::escape_debug`.
- EscapeDefault
  The return type of `str::escape_default`.
- EscapeUnicode
  The return type of `str::escape_unicode`.
- Lines
  An iterator over the lines of a string, as string slices.
- LinesAny Deprecated
  Created with the method `lines_any`.
- MatchIndices
  Created with the method `match_indices`.
- Matches
  Created with the method `matches`.
- ParseBoolError
  An error returned when parsing a `bool` using `from_str` fails
- RMatchIndices
  Created with the method `rmatch_indices`.
- RMatches
  Created with the method `rmatches`.
- RSplit
  Created with the method `rsplit`.
- RSplitN
  Created with the method `rsplitn`.
- RSplitTerminator
  Created with the method `rsplit_terminator`.
- Split
  Created with the method `split`.
- SplitAsciiWhitespace
  An iterator over the non-ASCII-whitespace substrings of a string, separated by any amount of ASCII whitespace.
- SplitInclusive
  An iterator over the substrings of a string, terminated by a substring matching to a predicate function Unlike `Split`, it contains the matched part as a terminator of the subslice.
- SplitN
  Created with the method `splitn`.
- SplitTerminator
  Created with the method `split_terminator`.
- SplitWhitespace
  An iterator over the non-whitespace substrings of a string, separated by any amount of whitespace.
- Utf8Error
  Errors which can occur when attempting to interpret a sequence of `u8` as a string.

## Traits

- FromStr
  Parse a value from a string

## Functions

- from_boxed_utf8_unchecked⚠
  Converts a boxed slice of bytes to a boxed string slice without checking that the string contains valid UTF-8.
- from_utf8
  Converts a slice of bytes to a string slice.
- from_utf8_mut
  Converts a mutable slice of bytes to a mutable string slice.
- from_utf8_unchecked⚠
  Converts a slice of bytes to a string slice without checking that the string contains valid UTF-8.
- from_utf8_unchecked_mut⚠
  Converts a slice of bytes to a string slice without checking that the string contains valid UTF-8; mutable version.