about summary refs log tree commit diff
path: root/src/libstd/num/uint_macros.rs
diff options
context:
space:
mode:
authorJacob Hegna <jacobhegna@gmail.com>2014-04-27 15:49:47 -0500
committerJacob Hegna <jacobhegna@gmail.com>2014-04-27 15:49:47 -0500
commitb8f5090a9a10e4dcc20dc64ee61a7b3749500738 (patch)
tree83f0c374b3c1116619d3993e3a6c4f9f08dd59b2 /src/libstd/num/uint_macros.rs
parent3ffe56ce38d8680fa3c1a7cfd6f8bde609e4bc7a (diff)
downloadrust-b8f5090a9a10e4dcc20dc64ee61a7b3749500738.tar.gz
rust-b8f5090a9a10e4dcc20dc64ee61a7b3749500738.zip
Rewrote documentation for parse_bytes and to_str_bytes in {int, uint}_macros.rs
Diffstat (limited to 'src/libstd/num/uint_macros.rs')
-rw-r--r--src/libstd/num/uint_macros.rs19
1 files changed, 14 insertions, 5 deletions
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