auto merge of #15271 : jasonthompson/rust/docs/str, r=huonw

I'm working on adding examples to the API documentation. Should future pull requests include examples for more than one function? Or is this about the right size for a pull request?
This commit is contained in:
bors 2014-07-01 01:01:36 +00:00
commit 90ab2f8b61
1 changed files with 8 additions and 0 deletions

View File

@ -106,6 +106,14 @@ pub fn from_utf8_owned(vv: Vec<u8>) -> Result<String, Vec<u8>> {
/// # Failure
///
/// Fails if invalid UTF-8
///
/// # Example
///
/// ```rust
/// use std::str;
/// let string = str::from_byte(66u8);
/// assert_eq!(string.as_slice(), "B");
/// ```
pub fn from_byte(b: u8) -> String {
assert!(b < 128u8);
String::from_char(1, b as char)