mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-22 14:55:26 +00:00
Include Strings guide with the others.
Three small changes: 1. Re-organize headers in the Strings guide so they show up correctly. 2. build the strings guide with the other docs 3. include the strings guide in the list of guides
This commit is contained in:
parent
4418664177
commit
0c30e1faad
@ -30,7 +30,7 @@ DOCS := index intro tutorial guide guide-ffi guide-macros guide-lifetimes \
|
||||
guide-tasks guide-container guide-pointers guide-testing \
|
||||
guide-runtime complement-bugreport \
|
||||
complement-lang-faq complement-design-faq complement-project-faq rust \
|
||||
rustdoc guide-unsafe
|
||||
rustdoc guide-unsafe guide-strings
|
||||
|
||||
PDF_DOCS := tutorial rust
|
||||
|
||||
|
@ -1,7 +1,5 @@
|
||||
% The Strings Guide
|
||||
|
||||
# Strings
|
||||
|
||||
Strings are an important concept to master in any programming language. If you
|
||||
come from a managed language background, you may be surprised at the complexity
|
||||
of string handling in a systems programming language. Efficient access and
|
||||
@ -14,7 +12,7 @@ Additionally, strings are not null-terminated and can contain null bytes.
|
||||
|
||||
Rust has two main types of strings: `&str` and `String`.
|
||||
|
||||
## &str
|
||||
# &str
|
||||
|
||||
The first kind is a `&str`. This is pronounced a 'string slice.' String literals
|
||||
are of the type `&str`:
|
||||
@ -38,7 +36,7 @@ Like vector slices, string slices are simply a pointer plus a length. This
|
||||
means that they're a 'view' into an already-allocated string, such as a
|
||||
`&'static str` or a `String`.
|
||||
|
||||
## String
|
||||
# String
|
||||
|
||||
A `String` is a heap-allocated string. This string is growable, and is also
|
||||
guaranteed to be UTF-8.
|
||||
@ -73,9 +71,9 @@ let x: &[u8] = &[b'a', b'b'];
|
||||
let stack_str: &str = str::from_utf8(x).unwrap();
|
||||
```
|
||||
|
||||
## Best Practices
|
||||
# Best Practices
|
||||
|
||||
### `String` vs. `&str`
|
||||
## `String` vs. `&str`
|
||||
|
||||
In general, you should prefer `String` when you need ownership, and `&str` when
|
||||
you just need to borrow a string. This is very similar to using `Vec<T>` vs. `&[T]`,
|
||||
@ -98,7 +96,7 @@ need, and it can make your lifetimes more complex. Furthermore, you can pass
|
||||
either kind of string into `foo` by using `.as_slice()` on any `String` you
|
||||
need to pass in, so the `&str` version is more flexible.
|
||||
|
||||
### Comparisons
|
||||
## Comparisons
|
||||
|
||||
To compare a String to a constant string, prefer `as_slice()`...
|
||||
|
||||
@ -123,7 +121,7 @@ fn compare(string: String) {
|
||||
Converting a `String` to a `&str` is cheap, but converting the `&str` to a
|
||||
`String` involves an allocation.
|
||||
|
||||
## Other Documentation
|
||||
# Other Documentation
|
||||
|
||||
* [the `&str` API documentation](/std/str/index.html)
|
||||
* [the `String` API documentation](std/string/index.html)
|
||||
|
@ -13,6 +13,7 @@ li {list-style-type: none; }
|
||||
|
||||
# Guides
|
||||
|
||||
* [Strings](guide-strings.html)
|
||||
* [Pointers](guide-pointers.html)
|
||||
* [References and Lifetimes](guide-lifetimes.html)
|
||||
* [Containers and Iterators](guide-container.html)
|
||||
|
Loading…
Reference in New Issue
Block a user