diff options
| author | bors <bors@rust-lang.org> | 2014-04-27 14:36:41 -0700 |
|---|---|---|
| committer | bors <bors@rust-lang.org> | 2014-04-27 14:36:41 -0700 |
| commit | 479b8a812c011ee103b52cab665a3d6f02c40ddf (patch) | |
| tree | d0c90d2e83b48dd74ab0640b7e61197bb50b3330 /src/libstd | |
| parent | 02ba8e275419798be044e68379b25cc8ab52a97c (diff) | |
| parent | b8f5090a9a10e4dcc20dc64ee61a7b3749500738 (diff) | |
| download | rust-479b8a812c011ee103b52cab665a3d6f02c40ddf.tar.gz rust-479b8a812c011ee103b52cab665a3d6f02c40ddf.zip | |
auto merge of #13792 : jacob-hegna/rust/master, r=alexcrichton
Just modified the documentation for parse_bytes to make it more clear how the bytes were parsed (big endian) and to show an example of what it returned. I also added documentation for the to_str_bytes which previously had no documentation (besides one stackoverflow post).
Diffstat (limited to 'src/libstd')
| -rw-r--r-- | src/libstd/num/int_macros.rs | 19 | ||||
| -rw-r--r-- | src/libstd/num/uint_macros.rs | 19 |
2 files changed, 28 insertions, 10 deletions
diff --git a/src/libstd/num/int_macros.rs b/src/libstd/num/int_macros.rs index cacd8d0aef9..c6a9924e4ec 100644 --- a/src/libstd/num/int_macros.rs +++ b/src/libstd/num/int_macros.rs @@ -234,16 +234,15 @@ impl Primitive for $T {} // String conversion functions and impl str -> num -/// Parse a byte slice as a number in the given base. +/// Parse a byte slice as a number in the given base /// /// Yields an `Option` because `buf` may or may not actually be parseable. /// /// # Examples /// -/// ```rust -/// let digits = [49,50,51,52,53,54,55,56,57]; -/// let base = 10; -/// let num = std::i64::parse_bytes(digits, base); +/// ``` +/// let num = std::i64::parse_bytes([49,50,51,52,53,54,55,56,57], 10); +/// assert!(num == Some(123456789)); /// ``` #[inline] pub fn parse_bytes(buf: &[u8], radix: uint) -> Option<$T> { @@ -270,6 +269,16 @@ impl FromStrRadix for $T { // String conversion functions and impl num -> str /// Convert to a string as a byte slice in a given base. +/// +/// Use in place of x.to_str() when you do not need to store the string permanently +/// +/// # Examples +/// +/// ``` +/// std::int::to_str_bytes(123, 10, |v| { +/// assert!(v == "123".as_bytes()); +/// }); +/// ``` #[inline] pub fn to_str_bytes<U>(n: $T, radix: uint, f: |v: &[u8]| -> U) -> U { // The radix can be as low as 2, so we need at least 64 characters for a diff --git a/src/libstd/num/uint_macros.rs b/src/libstd/num/uint_macros.rs index 697390a0069..8acedb080c2 100644 --- a/src/libstd/num/uint_macros.rs +++ b/src/libstd/num/uint_macros.rs @@ -148,16 +148,15 @@ impl Int for $T {} // String conversion functions and impl str -> num -/// Parse a byte slice as a number in the given base. +/// Parse a byte slice as a number in the given base /// /// Yields an `Option` because `buf` may or may not actually be parseable. /// /// # Examples /// -/// ```rust -/// let digits = [49,50,51,52,53,54,55,56,57]; -/// let base = 10; -/// let num = std::i64::parse_bytes(digits, base); +/// ``` +/// let num = std::uint::parse_bytes([49,50,51,52,53,54,55,56,57], 10); +/// assert!(num == Some(123456789)); /// ``` #[inline] pub fn parse_bytes(buf: &[u8], radix: uint) -> Option<$T> { @@ -184,6 +183,16 @@ impl FromStrRadix for $T { // String conversion functions and impl num -> str /// Convert to a string as a byte slice in a given base. +/// +/// Use in place of x.to_str() when you do not need to store the string permanently +/// +/// # Examples +/// +/// ``` +/// std::uint::to_str_bytes(123, 10, |v| { +/// assert!(v == "123".as_bytes()); +/// }); +/// ``` #[inline] pub fn to_str_bytes<U>(n: $T, radix: uint, f: |v: &[u8]| -> U) -> U { // The radix can be as low as 2, so we need at least 64 characters for a |