diff options
| author | Eugene Bulkin <ebulkin@caltech.edu> | 2017-04-01 00:47:58 -0700 |
|---|---|---|
| committer | Eugene Bulkin <ebulkin@caltech.edu> | 2017-04-01 00:47:58 -0700 |
| commit | a5d775d2b6b0b5f8e595d83b2fc10d74036aa36a (patch) | |
| tree | ee3e6fb30ece2bde77570457df510a6fe9535bdc /src/libstd/ascii.rs | |
| parent | d8fb322acc5314efc3026b889594c92c320dce85 (diff) | |
| download | rust-a5d775d2b6b0b5f8e595d83b2fc10d74036aa36a.tar.gz rust-a5d775d2b6b0b5f8e595d83b2fc10d74036aa36a.zip | |
Add more std::ascii module-level docs.
Diffstat (limited to 'src/libstd/ascii.rs')
| -rw-r--r-- | src/libstd/ascii.rs | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/src/libstd/ascii.rs b/src/libstd/ascii.rs index 12ea9ab431d..b3625386209 100644 --- a/src/libstd/ascii.rs +++ b/src/libstd/ascii.rs @@ -9,6 +9,20 @@ // except according to those terms. //! Operations on ASCII strings and characters. +//! +//! Most string operations in Rust act on UTF-8 strings. However, at times it +//! makes more sense to only consider the ASCII character set for a specific +//! operation. +//! +//! The [`AsciiExt`] trait provides methods that allow for character +//! operations that only act on the ASCII subset and leave non-ASCII characters +//! alone. +//! +//! The [`escape_default`] function provides an iterator over the bytes of an +//! escaped version of the character given. +//! +//! [`AsciiExt`]: trait.AsciiExt.html +//! [`escape_default`]: fn.escape_default.html #![stable(feature = "rust1", since = "1.0.0")] |