Rollup merge of #23297 - steveklabnik:examples, r=huonw
This brings comments in line with https://github.com/rust-lang/rfcs/blob/master/text/0505-api-comment-conventions.md#using-markdown
This commit is contained in:
commit
0a74387b64
|
@ -28,7 +28,7 @@ The other kind of comment is a doc comment. Doc comments use `///` instead of
|
||||||
///
|
///
|
||||||
/// * `name` - The name of the person you'd like to greet.
|
/// * `name` - The name of the person you'd like to greet.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let name = "Steve";
|
/// let name = "Steve";
|
||||||
|
|
|
@ -88,7 +88,7 @@ use heap::deallocate;
|
||||||
|
|
||||||
/// An atomically reference counted wrapper for shared state.
|
/// An atomically reference counted wrapper for shared state.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// In this example, a large vector of floats is shared between several tasks.
|
/// In this example, a large vector of floats is shared between several tasks.
|
||||||
/// With simple pipes, without `Arc`, a copy would have to be made for each
|
/// With simple pipes, without `Arc`, a copy would have to be made for each
|
||||||
|
|
|
@ -133,7 +133,7 @@ impl<T : ?Sized> Box<T> {
|
||||||
/// automatically managed that may lead to memory or other resource
|
/// automatically managed that may lead to memory or other resource
|
||||||
/// leak.
|
/// leak.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::boxed;
|
/// use std::boxed;
|
||||||
///
|
///
|
||||||
|
|
|
@ -264,7 +264,7 @@ pub fn is_unique<T>(rc: &Rc<T>) -> bool {
|
||||||
///
|
///
|
||||||
/// If the `Rc<T>` is not unique, an `Err` is returned with the same `Rc<T>`.
|
/// If the `Rc<T>` is not unique, an `Err` is returned with the same `Rc<T>`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::rc::{self, Rc};
|
/// use std::rc::{self, Rc};
|
||||||
|
@ -298,7 +298,7 @@ pub fn try_unwrap<T>(rc: Rc<T>) -> Result<T, Rc<T>> {
|
||||||
///
|
///
|
||||||
/// Returns `None` if the `Rc<T>` is not unique.
|
/// Returns `None` if the `Rc<T>` is not unique.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::rc::{self, Rc};
|
/// use std::rc::{self, Rc};
|
||||||
|
|
|
@ -127,7 +127,7 @@ impl<T> ToOwned for T where T: Clone {
|
||||||
/// is desired, `to_mut` will obtain a mutable references to an owned
|
/// is desired, `to_mut` will obtain a mutable references to an owned
|
||||||
/// value, cloning if necessary.
|
/// value, cloning if necessary.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::borrow::Cow;
|
/// use std::borrow::Cow;
|
||||||
|
|
|
@ -1177,7 +1177,7 @@ impl<'a, K: Ord, V> OccupiedEntry<'a, K, V> {
|
||||||
impl<K, V> BTreeMap<K, V> {
|
impl<K, V> BTreeMap<K, V> {
|
||||||
/// Gets an iterator over the entries of the map.
|
/// Gets an iterator over the entries of the map.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::BTreeMap;
|
/// use std::collections::BTreeMap;
|
||||||
|
|
|
@ -420,7 +420,7 @@ use string;
|
||||||
///
|
///
|
||||||
/// * args - a structure of arguments generated via the `format_args!` macro.
|
/// * args - a structure of arguments generated via the `format_args!` macro.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::fmt;
|
/// use std::fmt;
|
||||||
|
|
|
@ -48,7 +48,7 @@ macro_rules! vec {
|
||||||
/// Use the syntax described in `std::fmt` to create a value of type `String`.
|
/// Use the syntax described in `std::fmt` to create a value of type `String`.
|
||||||
/// See `std::fmt` for more information.
|
/// See `std::fmt` for more information.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// format!("test");
|
/// format!("test");
|
||||||
|
|
|
@ -277,7 +277,7 @@ pub trait SliceExt {
|
||||||
///
|
///
|
||||||
/// Panics if `size` is 0.
|
/// Panics if `size` is 0.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Print the adjacent pairs of a slice (i.e. `[1,2]`, `[2,3]`,
|
/// Print the adjacent pairs of a slice (i.e. `[1,2]`, `[2,3]`,
|
||||||
/// `[3,4]`):
|
/// `[3,4]`):
|
||||||
|
@ -300,7 +300,7 @@ pub trait SliceExt {
|
||||||
///
|
///
|
||||||
/// Panics if `size` is 0.
|
/// Panics if `size` is 0.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Print the slice two elements at a time (i.e. `[1,2]`,
|
/// Print the slice two elements at a time (i.e. `[1,2]`,
|
||||||
/// `[3,4]`, `[5]`):
|
/// `[3,4]`, `[5]`):
|
||||||
|
@ -390,7 +390,7 @@ pub trait SliceExt {
|
||||||
/// `Err` is returned, containing the index where a matching
|
/// `Err` is returned, containing the index where a matching
|
||||||
/// element could be inserted while maintaining sorted order.
|
/// element could be inserted while maintaining sorted order.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Looks up a series of four elements. The first is found, with a
|
/// Looks up a series of four elements. The first is found, with a
|
||||||
/// uniquely determined position; the second and third are not
|
/// uniquely determined position; the second and third are not
|
||||||
|
@ -416,7 +416,7 @@ pub trait SliceExt {
|
||||||
|
|
||||||
/// Return the number of elements in the slice
|
/// Return the number of elements in the slice
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let a = [1, 2, 3];
|
/// let a = [1, 2, 3];
|
||||||
|
@ -427,7 +427,7 @@ pub trait SliceExt {
|
||||||
|
|
||||||
/// Returns true if the slice has a length of 0
|
/// Returns true if the slice has a length of 0
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let a = [1, 2, 3];
|
/// let a = [1, 2, 3];
|
||||||
|
@ -529,7 +529,7 @@ pub trait SliceExt {
|
||||||
///
|
///
|
||||||
/// Panics if `a` or `b` are out of bounds.
|
/// Panics if `a` or `b` are out of bounds.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let mut v = ["a", "b", "c", "d"];
|
/// let mut v = ["a", "b", "c", "d"];
|
||||||
|
@ -549,7 +549,7 @@ pub trait SliceExt {
|
||||||
///
|
///
|
||||||
/// Panics if `mid > len`.
|
/// Panics if `mid > len`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let mut v = [1, 2, 3, 4, 5, 6];
|
/// let mut v = [1, 2, 3, 4, 5, 6];
|
||||||
|
@ -578,7 +578,7 @@ pub trait SliceExt {
|
||||||
|
|
||||||
/// Reverse the order of elements in a slice, in place.
|
/// Reverse the order of elements in a slice, in place.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let mut v = [1, 2, 3];
|
/// let mut v = [1, 2, 3];
|
||||||
|
@ -638,7 +638,7 @@ pub trait SliceExt {
|
||||||
/// shorter of `self.len()` and `src.len()`). Returns the number
|
/// shorter of `self.len()` and `src.len()`). Returns the number
|
||||||
/// of elements copied.
|
/// of elements copied.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let mut dst = [0, 0, 0];
|
/// let mut dst = [0, 0, 0];
|
||||||
|
@ -676,7 +676,7 @@ pub trait SliceExt {
|
||||||
/// `Err` is returned, containing the index where a matching
|
/// `Err` is returned, containing the index where a matching
|
||||||
/// element could be inserted while maintaining sorted order.
|
/// element could be inserted while maintaining sorted order.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Looks up a series of four elements. The first is found, with a
|
/// Looks up a series of four elements. The first is found, with a
|
||||||
/// uniquely determined position; the second and third are not
|
/// uniquely determined position; the second and third are not
|
||||||
|
@ -707,7 +707,7 @@ pub trait SliceExt {
|
||||||
/// Returns `true` if successful and `false` if the slice is at the
|
/// Returns `true` if successful and `false` if the slice is at the
|
||||||
/// last-ordered permutation.
|
/// last-ordered permutation.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let v: &mut [_] = &mut [0, 1, 2];
|
/// let v: &mut [_] = &mut [0, 1, 2];
|
||||||
|
@ -727,7 +727,7 @@ pub trait SliceExt {
|
||||||
/// Returns `true` if successful and `false` if the slice is at the
|
/// Returns `true` if successful and `false` if the slice is at the
|
||||||
/// first-ordered permutation.
|
/// first-ordered permutation.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let v: &mut [_] = &mut [1, 0, 2];
|
/// let v: &mut [_] = &mut [1, 0, 2];
|
||||||
|
|
|
@ -1377,7 +1377,7 @@ pub trait StrExt: Index<RangeFull, Output = str> {
|
||||||
///
|
///
|
||||||
/// Will return `Err` if it's not possible to parse `self` into the type.
|
/// Will return `Err` if it's not possible to parse `self` into the type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// assert_eq!("4".parse::<u32>(), Ok(4));
|
/// assert_eq!("4".parse::<u32>(), Ok(4));
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
//! "finally" case. For advanced cases, the `try_finally` function can
|
//! "finally" case. For advanced cases, the `try_finally` function can
|
||||||
//! also be used. See that function for more details.
|
//! also be used. See that function for more details.
|
||||||
//!
|
//!
|
||||||
//! # Example
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
//! # #![feature(unboxed_closures)]
|
//! # #![feature(unboxed_closures)]
|
||||||
|
@ -67,7 +67,7 @@ impl<T, F> Finally<T> for F where F: FnMut() -> T {
|
||||||
/// function could have panicked at any point, so the values of the shared
|
/// function could have panicked at any point, so the values of the shared
|
||||||
/// state may be inconsistent.
|
/// state may be inconsistent.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::finally::try_finally;
|
/// use std::finally::try_finally;
|
||||||
|
|
|
@ -143,7 +143,7 @@ pub struct RadixFmt<T, R>(T, R);
|
||||||
|
|
||||||
/// Constructs a radix formatter in the range of `2..36`.
|
/// Constructs a radix formatter in the range of `2..36`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::fmt::radix;
|
/// use std::fmt::radix;
|
||||||
|
|
|
@ -2296,7 +2296,7 @@ impl<I: RandomAccessIterator, F> RandomAccessIterator for Inspect<I, F>
|
||||||
|
|
||||||
/// An iterator that passes mutable state to a closure and yields the result.
|
/// An iterator that passes mutable state to a closure and yields the result.
|
||||||
///
|
///
|
||||||
/// # Example: The Fibonacci Sequence
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// An iterator that yields sequential Fibonacci numbers, and stops on overflow.
|
/// An iterator that yields sequential Fibonacci numbers, and stops on overflow.
|
||||||
///
|
///
|
||||||
|
|
|
@ -33,7 +33,7 @@ macro_rules! panic {
|
||||||
/// This will invoke the `panic!` macro if the provided expression cannot be
|
/// This will invoke the `panic!` macro if the provided expression cannot be
|
||||||
/// evaluated to `true` at runtime.
|
/// evaluated to `true` at runtime.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// // the panic message for these assertions is the stringified value of the
|
/// // the panic message for these assertions is the stringified value of the
|
||||||
|
@ -71,7 +71,7 @@ macro_rules! assert {
|
||||||
///
|
///
|
||||||
/// On panic, this macro will print the values of the expressions.
|
/// On panic, this macro will print the values of the expressions.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let a = 3;
|
/// let a = 3;
|
||||||
|
@ -107,7 +107,7 @@ macro_rules! assert_eq {
|
||||||
/// expensive to be present in a release build but may be helpful during
|
/// expensive to be present in a release build but may be helpful during
|
||||||
/// development.
|
/// development.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// // the panic message for these assertions is the stringified value of the
|
/// // the panic message for these assertions is the stringified value of the
|
||||||
|
@ -142,7 +142,7 @@ macro_rules! debug_assert {
|
||||||
/// expensive to be present in a release build but may be helpful during
|
/// expensive to be present in a release build but may be helpful during
|
||||||
/// development.
|
/// development.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let a = 3;
|
/// let a = 3;
|
||||||
|
@ -172,7 +172,7 @@ macro_rules! try {
|
||||||
/// Use the `format!` syntax to write data into a buffer of type `&mut Writer`.
|
/// Use the `format!` syntax to write data into a buffer of type `&mut Writer`.
|
||||||
/// See `std::fmt` for more information.
|
/// See `std::fmt` for more information.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -288,7 +288,7 @@ impl<T:?Sized> MarkerTrait for T { }
|
||||||
/// can extend `MarkerTrait`, which is equivalent to
|
/// can extend `MarkerTrait`, which is equivalent to
|
||||||
/// `PhantomFn<Self>`.
|
/// `PhantomFn<Self>`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// As an example, consider a trait with no methods like `Even`, meant
|
/// As an example, consider a trait with no methods like `Even`, meant
|
||||||
/// to represent types that are "even":
|
/// to represent types that are "even":
|
||||||
|
|
|
@ -82,7 +82,7 @@ pub trait Int
|
||||||
|
|
||||||
/// Returns the number of ones in the binary representation of `self`.
|
/// Returns the number of ones in the binary representation of `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -97,7 +97,7 @@ pub trait Int
|
||||||
|
|
||||||
/// Returns the number of zeros in the binary representation of `self`.
|
/// Returns the number of zeros in the binary representation of `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -116,7 +116,7 @@ pub trait Int
|
||||||
/// Returns the number of leading zeros in the binary representation
|
/// Returns the number of leading zeros in the binary representation
|
||||||
/// of `self`.
|
/// of `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -132,7 +132,7 @@ pub trait Int
|
||||||
/// Returns the number of trailing zeros in the binary representation
|
/// Returns the number of trailing zeros in the binary representation
|
||||||
/// of `self`.
|
/// of `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -148,7 +148,7 @@ pub trait Int
|
||||||
/// Shifts the bits to the left by a specified amount amount, `n`, wrapping
|
/// Shifts the bits to the left by a specified amount amount, `n`, wrapping
|
||||||
/// the truncated bits to the end of the resulting integer.
|
/// the truncated bits to the end of the resulting integer.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -165,7 +165,7 @@ pub trait Int
|
||||||
/// Shifts the bits to the right by a specified amount amount, `n`, wrapping
|
/// Shifts the bits to the right by a specified amount amount, `n`, wrapping
|
||||||
/// the truncated bits to the beginning of the resulting integer.
|
/// the truncated bits to the beginning of the resulting integer.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -181,7 +181,7 @@ pub trait Int
|
||||||
|
|
||||||
/// Reverses the byte order of the integer.
|
/// Reverses the byte order of the integer.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -198,7 +198,7 @@ pub trait Int
|
||||||
///
|
///
|
||||||
/// On big endian this is a no-op. On little endian the bytes are swapped.
|
/// On big endian this is a no-op. On little endian the bytes are swapped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -221,7 +221,7 @@ pub trait Int
|
||||||
///
|
///
|
||||||
/// On little endian this is a no-op. On big endian the bytes are swapped.
|
/// On little endian this is a no-op. On big endian the bytes are swapped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -244,7 +244,7 @@ pub trait Int
|
||||||
///
|
///
|
||||||
/// On big endian this is a no-op. On little endian the bytes are swapped.
|
/// On big endian this is a no-op. On little endian the bytes are swapped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -267,7 +267,7 @@ pub trait Int
|
||||||
///
|
///
|
||||||
/// On little endian this is a no-op. On big endian the bytes are swapped.
|
/// On little endian this is a no-op. On big endian the bytes are swapped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -289,7 +289,7 @@ pub trait Int
|
||||||
/// Checked integer addition. Computes `self + other`, returning `None` if
|
/// Checked integer addition. Computes `self + other`, returning `None` if
|
||||||
/// overflow occurred.
|
/// overflow occurred.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -303,7 +303,7 @@ pub trait Int
|
||||||
/// Checked integer subtraction. Computes `self - other`, returning `None`
|
/// Checked integer subtraction. Computes `self - other`, returning `None`
|
||||||
/// if underflow occurred.
|
/// if underflow occurred.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -317,7 +317,7 @@ pub trait Int
|
||||||
/// Checked integer multiplication. Computes `self * other`, returning
|
/// Checked integer multiplication. Computes `self * other`, returning
|
||||||
/// `None` if underflow or overflow occurred.
|
/// `None` if underflow or overflow occurred.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -331,7 +331,7 @@ pub trait Int
|
||||||
/// Checked integer division. Computes `self / other`, returning `None` if
|
/// Checked integer division. Computes `self / other`, returning `None` if
|
||||||
/// `other == 0` or the operation results in underflow or overflow.
|
/// `other == 0` or the operation results in underflow or overflow.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -369,7 +369,7 @@ pub trait Int
|
||||||
|
|
||||||
/// Raises self to the power of `exp`, using exponentiation by squaring.
|
/// Raises self to the power of `exp`, using exponentiation by squaring.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::num::Int;
|
/// use std::num::Int;
|
||||||
|
@ -1273,7 +1273,7 @@ impl_from_primitive! { f64, to_f64 }
|
||||||
|
|
||||||
/// Cast from one machine scalar to another.
|
/// Cast from one machine scalar to another.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::num;
|
/// use std::num;
|
||||||
|
|
|
@ -27,7 +27,7 @@
|
||||||
//! idea to have both `T` and `&T` implement the traits `Add<T>` and `Add<&T>`
|
//! idea to have both `T` and `&T` implement the traits `Add<T>` and `Add<&T>`
|
||||||
//! so that generic code can be written without unnecessary cloning.
|
//! so that generic code can be written without unnecessary cloning.
|
||||||
//!
|
//!
|
||||||
//! # Example
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! This example creates a `Point` struct that implements `Add` and `Sub`, and then
|
//! This example creates a `Point` struct that implements `Add` and `Sub`, and then
|
||||||
//! demonstrates adding and subtracting two `Point`s.
|
//! demonstrates adding and subtracting two `Point`s.
|
||||||
|
@ -73,7 +73,7 @@ use fmt;
|
||||||
/// The `Drop` trait is used to run some code when a value goes out of scope. This
|
/// The `Drop` trait is used to run some code when a value goes out of scope. This
|
||||||
/// is sometimes called a 'destructor'.
|
/// is sometimes called a 'destructor'.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Drop`. The `drop` method is called when `_x` goes
|
/// A trivial implementation of `Drop`. The `drop` method is called when `_x` goes
|
||||||
/// out of scope, and therefore `main` prints `Dropping!`.
|
/// out of scope, and therefore `main` prints `Dropping!`.
|
||||||
|
@ -157,7 +157,7 @@ macro_rules! forward_ref_binop {
|
||||||
|
|
||||||
/// The `Add` trait is used to specify the functionality of `+`.
|
/// The `Add` trait is used to specify the functionality of `+`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Add`. When `Foo + Foo` happens, it ends up
|
/// A trivial implementation of `Add`. When `Foo + Foo` happens, it ends up
|
||||||
/// calling `add`, and therefore, `main` prints `Adding!`.
|
/// calling `add`, and therefore, `main` prints `Adding!`.
|
||||||
|
@ -211,7 +211,7 @@ add_impl! { usize u8 u16 u32 u64 isize i8 i16 i32 i64 f32 f64 }
|
||||||
|
|
||||||
/// The `Sub` trait is used to specify the functionality of `-`.
|
/// The `Sub` trait is used to specify the functionality of `-`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Sub`. When `Foo - Foo` happens, it ends up
|
/// A trivial implementation of `Sub`. When `Foo - Foo` happens, it ends up
|
||||||
/// calling `sub`, and therefore, `main` prints `Subtracting!`.
|
/// calling `sub`, and therefore, `main` prints `Subtracting!`.
|
||||||
|
@ -265,7 +265,7 @@ sub_impl! { usize u8 u16 u32 u64 isize i8 i16 i32 i64 f32 f64 }
|
||||||
|
|
||||||
/// The `Mul` trait is used to specify the functionality of `*`.
|
/// The `Mul` trait is used to specify the functionality of `*`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Mul`. When `Foo * Foo` happens, it ends up
|
/// A trivial implementation of `Mul`. When `Foo * Foo` happens, it ends up
|
||||||
/// calling `mul`, and therefore, `main` prints `Multiplying!`.
|
/// calling `mul`, and therefore, `main` prints `Multiplying!`.
|
||||||
|
@ -319,7 +319,7 @@ mul_impl! { usize u8 u16 u32 u64 isize i8 i16 i32 i64 f32 f64 }
|
||||||
|
|
||||||
/// The `Div` trait is used to specify the functionality of `/`.
|
/// The `Div` trait is used to specify the functionality of `/`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Div`. When `Foo / Foo` happens, it ends up
|
/// A trivial implementation of `Div`. When `Foo / Foo` happens, it ends up
|
||||||
/// calling `div`, and therefore, `main` prints `Dividing!`.
|
/// calling `div`, and therefore, `main` prints `Dividing!`.
|
||||||
|
@ -373,7 +373,7 @@ div_impl! { usize u8 u16 u32 u64 isize i8 i16 i32 i64 f32 f64 }
|
||||||
|
|
||||||
/// The `Rem` trait is used to specify the functionality of `%`.
|
/// The `Rem` trait is used to specify the functionality of `%`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Rem`. When `Foo % Foo` happens, it ends up
|
/// A trivial implementation of `Rem`. When `Foo % Foo` happens, it ends up
|
||||||
/// calling `rem`, and therefore, `main` prints `Remainder-ing!`.
|
/// calling `rem`, and therefore, `main` prints `Remainder-ing!`.
|
||||||
|
@ -446,7 +446,7 @@ rem_float_impl! { f64, fmod }
|
||||||
|
|
||||||
/// The `Neg` trait is used to specify the functionality of unary `-`.
|
/// The `Neg` trait is used to specify the functionality of unary `-`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Neg`. When `-Foo` happens, it ends up calling
|
/// A trivial implementation of `Neg`. When `-Foo` happens, it ends up calling
|
||||||
/// `neg`, and therefore, `main` prints `Negating!`.
|
/// `neg`, and therefore, `main` prints `Negating!`.
|
||||||
|
@ -523,7 +523,7 @@ neg_uint_impl! { u64, i64 }
|
||||||
|
|
||||||
/// The `Not` trait is used to specify the functionality of unary `!`.
|
/// The `Not` trait is used to specify the functionality of unary `!`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Not`. When `!Foo` happens, it ends up calling
|
/// A trivial implementation of `Not`. When `!Foo` happens, it ends up calling
|
||||||
/// `not`, and therefore, `main` prints `Not-ing!`.
|
/// `not`, and therefore, `main` prints `Not-ing!`.
|
||||||
|
@ -577,7 +577,7 @@ not_impl! { bool usize u8 u16 u32 u64 isize i8 i16 i32 i64 }
|
||||||
|
|
||||||
/// The `BitAnd` trait is used to specify the functionality of `&`.
|
/// The `BitAnd` trait is used to specify the functionality of `&`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `BitAnd`. When `Foo & Foo` happens, it ends up
|
/// A trivial implementation of `BitAnd`. When `Foo & Foo` happens, it ends up
|
||||||
/// calling `bitand`, and therefore, `main` prints `Bitwise And-ing!`.
|
/// calling `bitand`, and therefore, `main` prints `Bitwise And-ing!`.
|
||||||
|
@ -631,7 +631,7 @@ bitand_impl! { bool usize u8 u16 u32 u64 isize i8 i16 i32 i64 }
|
||||||
|
|
||||||
/// The `BitOr` trait is used to specify the functionality of `|`.
|
/// The `BitOr` trait is used to specify the functionality of `|`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `BitOr`. When `Foo | Foo` happens, it ends up
|
/// A trivial implementation of `BitOr`. When `Foo | Foo` happens, it ends up
|
||||||
/// calling `bitor`, and therefore, `main` prints `Bitwise Or-ing!`.
|
/// calling `bitor`, and therefore, `main` prints `Bitwise Or-ing!`.
|
||||||
|
@ -685,7 +685,7 @@ bitor_impl! { bool usize u8 u16 u32 u64 isize i8 i16 i32 i64 }
|
||||||
|
|
||||||
/// The `BitXor` trait is used to specify the functionality of `^`.
|
/// The `BitXor` trait is used to specify the functionality of `^`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `BitXor`. When `Foo ^ Foo` happens, it ends up
|
/// A trivial implementation of `BitXor`. When `Foo ^ Foo` happens, it ends up
|
||||||
/// calling `bitxor`, and therefore, `main` prints `Bitwise Xor-ing!`.
|
/// calling `bitxor`, and therefore, `main` prints `Bitwise Xor-ing!`.
|
||||||
|
@ -739,7 +739,7 @@ bitxor_impl! { bool usize u8 u16 u32 u64 isize i8 i16 i32 i64 }
|
||||||
|
|
||||||
/// The `Shl` trait is used to specify the functionality of `<<`.
|
/// The `Shl` trait is used to specify the functionality of `<<`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Shl`. When `Foo << Foo` happens, it ends up
|
/// A trivial implementation of `Shl`. When `Foo << Foo` happens, it ends up
|
||||||
/// calling `shl`, and therefore, `main` prints `Shifting left!`.
|
/// calling `shl`, and therefore, `main` prints `Shifting left!`.
|
||||||
|
@ -811,7 +811,7 @@ shl_impl_all! { u8 u16 u32 u64 usize i8 i16 i32 i64 isize }
|
||||||
|
|
||||||
/// The `Shr` trait is used to specify the functionality of `>>`.
|
/// The `Shr` trait is used to specify the functionality of `>>`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Shr`. When `Foo >> Foo` happens, it ends up
|
/// A trivial implementation of `Shr`. When `Foo >> Foo` happens, it ends up
|
||||||
/// calling `shr`, and therefore, `main` prints `Shifting right!`.
|
/// calling `shr`, and therefore, `main` prints `Shifting right!`.
|
||||||
|
@ -883,7 +883,7 @@ shr_impl_all! { u8 u16 u32 u64 usize i8 i16 i32 i64 isize }
|
||||||
/// The `Index` trait is used to specify the functionality of indexing operations
|
/// The `Index` trait is used to specify the functionality of indexing operations
|
||||||
/// like `arr[idx]` when used in an immutable context.
|
/// like `arr[idx]` when used in an immutable context.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `Index`. When `Foo[Bar]` happens, it ends up
|
/// A trivial implementation of `Index`. When `Foo[Bar]` happens, it ends up
|
||||||
/// calling `index`, and therefore, `main` prints `Indexing!`.
|
/// calling `index`, and therefore, `main` prints `Indexing!`.
|
||||||
|
@ -924,7 +924,7 @@ pub trait Index<Idx: ?Sized> {
|
||||||
/// The `IndexMut` trait is used to specify the functionality of indexing
|
/// The `IndexMut` trait is used to specify the functionality of indexing
|
||||||
/// operations like `arr[idx]`, when used in a mutable context.
|
/// operations like `arr[idx]`, when used in a mutable context.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A trivial implementation of `IndexMut`. When `Foo[Bar]` happens, it ends up
|
/// A trivial implementation of `IndexMut`. When `Foo[Bar]` happens, it ends up
|
||||||
/// calling `index_mut`, and therefore, `main` prints `Indexing!`.
|
/// calling `index_mut`, and therefore, `main` prints `Indexing!`.
|
||||||
|
@ -1033,7 +1033,7 @@ impl<Idx: fmt::Debug> fmt::Debug for RangeTo<Idx> {
|
||||||
/// The `Deref` trait is used to specify the functionality of dereferencing
|
/// The `Deref` trait is used to specify the functionality of dereferencing
|
||||||
/// operations like `*v`.
|
/// operations like `*v`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A struct with a single field which is accessible via dereferencing the
|
/// A struct with a single field which is accessible via dereferencing the
|
||||||
/// struct.
|
/// struct.
|
||||||
|
@ -1087,7 +1087,7 @@ impl<'a, T: ?Sized> Deref for &'a mut T {
|
||||||
/// The `DerefMut` trait is used to specify the functionality of dereferencing
|
/// The `DerefMut` trait is used to specify the functionality of dereferencing
|
||||||
/// mutably like `*v = 1;`
|
/// mutably like `*v = 1;`
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// A struct with a single field which is modifiable via dereferencing the
|
/// A struct with a single field which is modifiable via dereferencing the
|
||||||
/// struct.
|
/// struct.
|
||||||
|
|
|
@ -185,7 +185,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns `true` if the option is a `Some` value
|
/// Returns `true` if the option is a `Some` value
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Option<u32> = Some(2);
|
/// let x: Option<u32> = Some(2);
|
||||||
|
@ -205,7 +205,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns `true` if the option is a `None` value
|
/// Returns `true` if the option is a `None` value
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Option<u32> = Some(2);
|
/// let x: Option<u32> = Some(2);
|
||||||
|
@ -226,7 +226,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Convert from `Option<T>` to `Option<&T>`
|
/// Convert from `Option<T>` to `Option<&T>`
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Convert an `Option<String>` into an `Option<usize>`, preserving the original.
|
/// Convert an `Option<String>` into an `Option<usize>`, preserving the original.
|
||||||
/// The `map` method takes the `self` argument by value, consuming the original,
|
/// The `map` method takes the `self` argument by value, consuming the original,
|
||||||
|
@ -251,7 +251,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Convert from `Option<T>` to `Option<&mut T>`
|
/// Convert from `Option<T>` to `Option<&mut T>`
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let mut x = Some(2);
|
/// let mut x = Some(2);
|
||||||
|
@ -272,7 +272,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Convert from `Option<T>` to `&mut [T]` (without copying)
|
/// Convert from `Option<T>` to `&mut [T]` (without copying)
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let mut x = Some("Diamonds");
|
/// let mut x = Some("Diamonds");
|
||||||
|
@ -311,7 +311,7 @@ impl<T> Option<T> {
|
||||||
/// Panics if the value is a `None` with a custom panic message provided by
|
/// Panics if the value is a `None` with a custom panic message provided by
|
||||||
/// `msg`.
|
/// `msg`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some("value");
|
/// let x = Some("value");
|
||||||
|
@ -343,7 +343,7 @@ impl<T> Option<T> {
|
||||||
/// Instead, prefer to use pattern matching and handle the `None`
|
/// Instead, prefer to use pattern matching and handle the `None`
|
||||||
/// case explicitly.
|
/// case explicitly.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some("air");
|
/// let x = Some("air");
|
||||||
|
@ -365,7 +365,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns the contained value or a default.
|
/// Returns the contained value or a default.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// assert_eq!(Some("car").unwrap_or("bike"), "car");
|
/// assert_eq!(Some("car").unwrap_or("bike"), "car");
|
||||||
|
@ -382,7 +382,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns the contained value or computes it from a closure.
|
/// Returns the contained value or computes it from a closure.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let k = 10;
|
/// let k = 10;
|
||||||
|
@ -404,7 +404,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Maps an `Option<T>` to `Option<U>` by applying a function to a contained value
|
/// Maps an `Option<T>` to `Option<U>` by applying a function to a contained value
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Convert an `Option<String>` into an `Option<usize>`, consuming the original:
|
/// Convert an `Option<String>` into an `Option<usize>`, consuming the original:
|
||||||
///
|
///
|
||||||
|
@ -424,7 +424,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Applies a function to the contained value or returns a default.
|
/// Applies a function to the contained value or returns a default.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some("foo");
|
/// let x = Some("foo");
|
||||||
|
@ -444,7 +444,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Applies a function to the contained value or computes a default.
|
/// Applies a function to the contained value or computes a default.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let k = 21;
|
/// let k = 21;
|
||||||
|
@ -467,7 +467,7 @@ impl<T> Option<T> {
|
||||||
/// Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to
|
/// Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to
|
||||||
/// `Ok(v)` and `None` to `Err(err)`.
|
/// `Ok(v)` and `None` to `Err(err)`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some("foo");
|
/// let x = Some("foo");
|
||||||
|
@ -488,7 +488,7 @@ impl<T> Option<T> {
|
||||||
/// Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to
|
/// Transforms the `Option<T>` into a `Result<T, E>`, mapping `Some(v)` to
|
||||||
/// `Ok(v)` and `None` to `Err(err())`.
|
/// `Ok(v)` and `None` to `Err(err())`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some("foo");
|
/// let x = Some("foo");
|
||||||
|
@ -512,7 +512,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns an iterator over the possibly contained value.
|
/// Returns an iterator over the possibly contained value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some(4);
|
/// let x = Some(4);
|
||||||
|
@ -529,7 +529,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns a mutable iterator over the possibly contained value.
|
/// Returns a mutable iterator over the possibly contained value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let mut x = Some(4);
|
/// let mut x = Some(4);
|
||||||
|
@ -551,7 +551,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns a consuming iterator over the possibly contained value.
|
/// Returns a consuming iterator over the possibly contained value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some("string");
|
/// let x = Some("string");
|
||||||
|
@ -574,7 +574,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns `None` if the option is `None`, otherwise returns `optb`.
|
/// Returns `None` if the option is `None`, otherwise returns `optb`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some(2);
|
/// let x = Some(2);
|
||||||
|
@ -607,7 +607,7 @@ impl<T> Option<T> {
|
||||||
///
|
///
|
||||||
/// Some languages call this operation flatmap.
|
/// Some languages call this operation flatmap.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// fn sq(x: u32) -> Option<u32> { Some(x * x) }
|
/// fn sq(x: u32) -> Option<u32> { Some(x * x) }
|
||||||
|
@ -629,7 +629,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Returns the option if it contains a value, otherwise returns `optb`.
|
/// Returns the option if it contains a value, otherwise returns `optb`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x = Some(2);
|
/// let x = Some(2);
|
||||||
|
@ -660,7 +660,7 @@ impl<T> Option<T> {
|
||||||
/// Returns the option if it contains a value, otherwise calls `f` and
|
/// Returns the option if it contains a value, otherwise calls `f` and
|
||||||
/// returns the result.
|
/// returns the result.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// fn nobody() -> Option<&'static str> { None }
|
/// fn nobody() -> Option<&'static str> { None }
|
||||||
|
@ -685,7 +685,7 @@ impl<T> Option<T> {
|
||||||
|
|
||||||
/// Takes the value out of the option, leaving a `None` in its place.
|
/// Takes the value out of the option, leaving a `None` in its place.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let mut x = Some(2);
|
/// let mut x = Some(2);
|
||||||
|
@ -720,7 +720,7 @@ impl<T: Default> Option<T> {
|
||||||
/// value, otherwise if `None`, returns the default value for that
|
/// value, otherwise if `None`, returns the default value for that
|
||||||
/// type.
|
/// type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Convert a string to an integer, turning poorly-formed strings
|
/// Convert a string to an integer, turning poorly-formed strings
|
||||||
/// into 0 (the default value for integers). `parse` converts
|
/// into 0 (the default value for integers). `parse` converts
|
||||||
|
|
|
@ -265,7 +265,7 @@ impl<T, E> Result<T, E> {
|
||||||
|
|
||||||
/// Returns true if the result is `Ok`
|
/// Returns true if the result is `Ok`
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<int, &str> = Ok(-3);
|
/// let x: Result<int, &str> = Ok(-3);
|
||||||
|
@ -285,7 +285,7 @@ impl<T, E> Result<T, E> {
|
||||||
|
|
||||||
/// Returns true if the result is `Err`
|
/// Returns true if the result is `Err`
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<int, &str> = Ok(-3);
|
/// let x: Result<int, &str> = Ok(-3);
|
||||||
|
@ -309,7 +309,7 @@ impl<T, E> Result<T, E> {
|
||||||
/// Converts `self` into an `Option<T>`, consuming `self`,
|
/// Converts `self` into an `Option<T>`, consuming `self`,
|
||||||
/// and discarding the error, if any.
|
/// and discarding the error, if any.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<u32, &str> = Ok(2);
|
/// let x: Result<u32, &str> = Ok(2);
|
||||||
|
@ -332,7 +332,7 @@ impl<T, E> Result<T, E> {
|
||||||
/// Converts `self` into an `Option<E>`, consuming `self`,
|
/// Converts `self` into an `Option<E>`, consuming `self`,
|
||||||
/// and discarding the value, if any.
|
/// and discarding the value, if any.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<u32, &str> = Ok(2);
|
/// let x: Result<u32, &str> = Ok(2);
|
||||||
|
@ -440,7 +440,7 @@ impl<T, E> Result<T, E> {
|
||||||
///
|
///
|
||||||
/// This function can be used to compose the results of two functions.
|
/// This function can be used to compose the results of two functions.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Sum the lines of a buffer by mapping strings to numbers,
|
/// Sum the lines of a buffer by mapping strings to numbers,
|
||||||
/// ignoring I/O and parse errors:
|
/// ignoring I/O and parse errors:
|
||||||
|
@ -479,7 +479,7 @@ impl<T, E> Result<T, E> {
|
||||||
/// This function can be used to pass through a successful result while handling
|
/// This function can be used to pass through a successful result while handling
|
||||||
/// an error.
|
/// an error.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// fn stringify(x: u32) -> String { format!("error code: {}", x) }
|
/// fn stringify(x: u32) -> String { format!("error code: {}", x) }
|
||||||
|
@ -505,7 +505,7 @@ impl<T, E> Result<T, E> {
|
||||||
|
|
||||||
/// Returns an iterator over the possibly contained value.
|
/// Returns an iterator over the possibly contained value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<u32, &str> = Ok(7);
|
/// let x: Result<u32, &str> = Ok(7);
|
||||||
|
@ -522,7 +522,7 @@ impl<T, E> Result<T, E> {
|
||||||
|
|
||||||
/// Returns a mutable iterator over the possibly contained value.
|
/// Returns a mutable iterator over the possibly contained value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let mut x: Result<u32, &str> = Ok(7);
|
/// let mut x: Result<u32, &str> = Ok(7);
|
||||||
|
@ -543,7 +543,7 @@ impl<T, E> Result<T, E> {
|
||||||
|
|
||||||
/// Returns a consuming iterator over the possibly contained value.
|
/// Returns a consuming iterator over the possibly contained value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<u32, &str> = Ok(5);
|
/// let x: Result<u32, &str> = Ok(5);
|
||||||
|
@ -566,7 +566,7 @@ impl<T, E> Result<T, E> {
|
||||||
|
|
||||||
/// Returns `res` if the result is `Ok`, otherwise returns the `Err` value of `self`.
|
/// Returns `res` if the result is `Ok`, otherwise returns the `Err` value of `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<u32, &str> = Ok(2);
|
/// let x: Result<u32, &str> = Ok(2);
|
||||||
|
@ -598,7 +598,7 @@ impl<T, E> Result<T, E> {
|
||||||
///
|
///
|
||||||
/// This function can be used for control flow based on result values.
|
/// This function can be used for control flow based on result values.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
|
/// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
|
||||||
|
@ -620,7 +620,7 @@ impl<T, E> Result<T, E> {
|
||||||
|
|
||||||
/// Returns `res` if the result is `Err`, otherwise returns the `Ok` value of `self`.
|
/// Returns `res` if the result is `Err`, otherwise returns the `Ok` value of `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<u32, &str> = Ok(2);
|
/// let x: Result<u32, &str> = Ok(2);
|
||||||
|
@ -652,7 +652,7 @@ impl<T, E> Result<T, E> {
|
||||||
///
|
///
|
||||||
/// This function can be used for control flow based on result values.
|
/// This function can be used for control flow based on result values.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
|
/// fn sq(x: u32) -> Result<u32, u32> { Ok(x * x) }
|
||||||
|
@ -675,7 +675,7 @@ impl<T, E> Result<T, E> {
|
||||||
/// Unwraps a result, yielding the content of an `Ok`.
|
/// Unwraps a result, yielding the content of an `Ok`.
|
||||||
/// Else it returns `optb`.
|
/// Else it returns `optb`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let optb = 2;
|
/// let optb = 2;
|
||||||
|
@ -697,7 +697,7 @@ impl<T, E> Result<T, E> {
|
||||||
/// Unwraps a result, yielding the content of an `Ok`.
|
/// Unwraps a result, yielding the content of an `Ok`.
|
||||||
/// If the value is an `Err` then it calls `op` with its value.
|
/// If the value is an `Err` then it calls `op` with its value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// fn count(x: &str) -> usize { x.len() }
|
/// fn count(x: &str) -> usize { x.len() }
|
||||||
|
@ -724,7 +724,7 @@ impl<T, E: fmt::Debug> Result<T, E> {
|
||||||
/// Panics if the value is an `Err`, with a custom panic message provided
|
/// Panics if the value is an `Err`, with a custom panic message provided
|
||||||
/// by the `Err`'s value.
|
/// by the `Err`'s value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let x: Result<u32, &str> = Ok(2);
|
/// let x: Result<u32, &str> = Ok(2);
|
||||||
|
@ -755,7 +755,7 @@ impl<T: fmt::Debug, E> Result<T, E> {
|
||||||
/// Panics if the value is an `Ok`, with a custom panic message provided
|
/// Panics if the value is an `Ok`, with a custom panic message provided
|
||||||
/// by the `Ok`'s value.
|
/// by the `Ok`'s value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```{.should_fail}
|
/// ```{.should_fail}
|
||||||
/// let x: Result<u32, &str> = Ok(2);
|
/// let x: Result<u32, &str> = Ok(2);
|
||||||
|
|
|
@ -1433,7 +1433,7 @@ pub fn mut_ref_slice<'a, A>(s: &'a mut A) -> &'a mut [A] {
|
||||||
/// function taking the lifetime of a host value for the slice, or by explicit
|
/// function taking the lifetime of a host value for the slice, or by explicit
|
||||||
/// annotation.
|
/// annotation.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::slice;
|
/// use std::slice;
|
||||||
|
@ -1476,7 +1476,7 @@ pub unsafe fn from_raw_parts_mut<'a, T>(p: *mut T, len: usize) -> &'a mut [T] {
|
||||||
/// valid for `len` elements, nor whether the lifetime provided is a suitable
|
/// valid for `len` elements, nor whether the lifetime provided is a suitable
|
||||||
/// lifetime for the returned slice.
|
/// lifetime for the returned slice.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::slice;
|
/// use std::slice;
|
||||||
|
|
|
@ -1183,7 +1183,7 @@ mod traits {
|
||||||
/// Panics when `begin` and `end` do not point to valid characters
|
/// Panics when `begin` and `end` do not point to valid characters
|
||||||
/// or point beyond the last character of the string.
|
/// or point beyond the last character of the string.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let s = "Löwe 老虎 Léopard";
|
/// let s = "Löwe 老虎 Léopard";
|
||||||
|
|
|
@ -215,7 +215,7 @@ pub unsafe trait ReverseSearcher<'a>: Searcher<'a> {
|
||||||
/// the two ends of a range of values, that is they
|
/// the two ends of a range of values, that is they
|
||||||
/// can not "walk past each other".
|
/// can not "walk past each other".
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// `char::Searcher` is a `DoubleEndedSearcher` because searching for a
|
/// `char::Searcher` is a `DoubleEndedSearcher` because searching for a
|
||||||
/// `char` only requires looking at one at a time, which behaves the same
|
/// `char` only requires looking at one at a time, which behaves the same
|
||||||
|
|
|
@ -16,7 +16,7 @@
|
||||||
/// format!-based argument list. See documentation in `std::fmt` for details on
|
/// format!-based argument list. See documentation in `std::fmt` for details on
|
||||||
/// how to use the syntax.
|
/// how to use the syntax.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// #[macro_use] extern crate log;
|
/// #[macro_use] extern crate log;
|
||||||
|
@ -64,7 +64,7 @@ macro_rules! log {
|
||||||
|
|
||||||
/// A convenience macro for logging at the error log level.
|
/// A convenience macro for logging at the error log level.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// #[macro_use] extern crate log;
|
/// #[macro_use] extern crate log;
|
||||||
|
@ -89,7 +89,7 @@ macro_rules! error {
|
||||||
|
|
||||||
/// A convenience macro for logging at the warning log level.
|
/// A convenience macro for logging at the warning log level.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// #[macro_use] extern crate log;
|
/// #[macro_use] extern crate log;
|
||||||
|
@ -113,7 +113,7 @@ macro_rules! warn {
|
||||||
|
|
||||||
/// A convenience macro for logging at the info log level.
|
/// A convenience macro for logging at the info log level.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// #[macro_use] extern crate log;
|
/// #[macro_use] extern crate log;
|
||||||
|
@ -139,7 +139,7 @@ macro_rules! info {
|
||||||
/// be omitted at compile time by passing `--cfg ndebug` to the compiler. If
|
/// be omitted at compile time by passing `--cfg ndebug` to the compiler. If
|
||||||
/// this option is not passed, then debug statements will be compiled.
|
/// this option is not passed, then debug statements will be compiled.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// #[macro_use] extern crate log;
|
/// #[macro_use] extern crate log;
|
||||||
|
@ -162,7 +162,7 @@ macro_rules! debug {
|
||||||
|
|
||||||
/// A macro to test whether a log level is enabled for the current module.
|
/// A macro to test whether a log level is enabled for the current module.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// #[macro_use] extern crate log;
|
/// #[macro_use] extern crate log;
|
||||||
|
|
|
@ -57,7 +57,7 @@ impl Rand for Exp1 {
|
||||||
/// This distribution has density function: `f(x) = lambda *
|
/// This distribution has density function: `f(x) = lambda *
|
||||||
/// exp(-lambda * x)` for `x > 0`.
|
/// exp(-lambda * x)` for `x > 0`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
|
|
@ -37,7 +37,7 @@ use super::{IndependentSample, Sample, Exp};
|
||||||
/// == 1`, and using the boosting technique described in [1] for
|
/// == 1`, and using the boosting technique described in [1] for
|
||||||
/// `shape < 1`.
|
/// `shape < 1`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
@ -184,7 +184,7 @@ impl IndependentSample<f64> for GammaLargeShape {
|
||||||
/// `k`, this uses the equivalent characterisation `χ²(k) = Gamma(k/2,
|
/// `k`, this uses the equivalent characterisation `χ²(k) = Gamma(k/2,
|
||||||
/// 2)`.
|
/// 2)`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
@ -241,7 +241,7 @@ impl IndependentSample<f64> for ChiSquared {
|
||||||
/// chi-squared distributions, that is, `F(m,n) = (χ²(m)/m) /
|
/// chi-squared distributions, that is, `F(m,n) = (χ²(m)/m) /
|
||||||
/// (χ²(n)/n)`.
|
/// (χ²(n)/n)`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
@ -285,7 +285,7 @@ impl IndependentSample<f64> for FisherF {
|
||||||
/// The Student t distribution, `t(nu)`, where `nu` is the degrees of
|
/// The Student t distribution, `t(nu)`, where `nu` is the degrees of
|
||||||
/// freedom.
|
/// freedom.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
|
|
@ -93,7 +93,7 @@ pub struct Weighted<T> {
|
||||||
/// all `T`, as is `uint`, so one can store references or indices into
|
/// all `T`, as is `uint`, so one can store references or indices into
|
||||||
/// another vector.
|
/// another vector.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
|
|
@ -73,7 +73,7 @@ impl Rand for StandardNormal {
|
||||||
/// This uses the ZIGNOR variant of the Ziggurat method, see
|
/// This uses the ZIGNOR variant of the Ziggurat method, see
|
||||||
/// `StandardNormal` for more details.
|
/// `StandardNormal` for more details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
@ -121,7 +121,7 @@ impl IndependentSample<f64> for Normal {
|
||||||
/// If `X` is log-normal distributed, then `ln(X)` is `N(mean,
|
/// If `X` is log-normal distributed, then `ln(X)` is `N(mean,
|
||||||
/// std_dev**2)` distributed.
|
/// std_dev**2)` distributed.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand;
|
/// use std::rand;
|
||||||
|
|
|
@ -33,7 +33,7 @@ use distributions::{Sample, IndependentSample};
|
||||||
/// primitive integer types satisfy this property, and the float types
|
/// primitive integer types satisfy this property, and the float types
|
||||||
/// normally satisfy it, but rounding may mean `high` can occur.
|
/// normally satisfy it, but rounding may mean `high` can occur.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::distributions::{IndependentSample, Range};
|
/// use std::rand::distributions::{IndependentSample, Range};
|
||||||
|
|
|
@ -146,7 +146,7 @@ pub trait Rng : Sized {
|
||||||
/// (e.g. reading past the end of a file that is being used as the
|
/// (e.g. reading past the end of a file that is being used as the
|
||||||
/// source of randomness).
|
/// source of randomness).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -181,7 +181,7 @@ pub trait Rng : Sized {
|
||||||
|
|
||||||
/// Return a random value of a `Rand` type.
|
/// Return a random value of a `Rand` type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -199,7 +199,7 @@ pub trait Rng : Sized {
|
||||||
/// Return an iterator that will yield an infinite number of randomly
|
/// Return an iterator that will yield an infinite number of randomly
|
||||||
/// generated items.
|
/// generated items.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -226,7 +226,7 @@ pub trait Rng : Sized {
|
||||||
///
|
///
|
||||||
/// Panics if `low >= high`.
|
/// Panics if `low >= high`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -244,7 +244,7 @@ pub trait Rng : Sized {
|
||||||
|
|
||||||
/// Return a bool with a 1 in n chance of true
|
/// Return a bool with a 1 in n chance of true
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -258,7 +258,7 @@ pub trait Rng : Sized {
|
||||||
|
|
||||||
/// Return an iterator of random characters from the set A-Z,a-z,0-9.
|
/// Return an iterator of random characters from the set A-Z,a-z,0-9.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -274,7 +274,7 @@ pub trait Rng : Sized {
|
||||||
///
|
///
|
||||||
/// Return `None` if `values` is empty.
|
/// Return `None` if `values` is empty.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -294,7 +294,7 @@ pub trait Rng : Sized {
|
||||||
|
|
||||||
/// Shuffle a mutable slice in place.
|
/// Shuffle a mutable slice in place.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{thread_rng, Rng};
|
/// use std::rand::{thread_rng, Rng};
|
||||||
|
@ -357,7 +357,7 @@ impl<'a, R: Rng> Iterator for AsciiGenerator<'a, R> {
|
||||||
pub trait SeedableRng<Seed>: Rng {
|
pub trait SeedableRng<Seed>: Rng {
|
||||||
/// Reseed an RNG with the given seed.
|
/// Reseed an RNG with the given seed.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{Rng, SeedableRng, StdRng};
|
/// use std::rand::{Rng, SeedableRng, StdRng};
|
||||||
|
@ -372,7 +372,7 @@ pub trait SeedableRng<Seed>: Rng {
|
||||||
|
|
||||||
/// Create a new RNG with the given seed.
|
/// Create a new RNG with the given seed.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{Rng, SeedableRng, StdRng};
|
/// use std::rand::{Rng, SeedableRng, StdRng};
|
||||||
|
@ -477,7 +477,7 @@ impl Rand for XorShiftRng {
|
||||||
/// `Rand` implementation for `f32` and `f64` for the half-open
|
/// `Rand` implementation for `f32` and `f64` for the half-open
|
||||||
/// `[0,1)`.
|
/// `[0,1)`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{random, Open01};
|
/// use std::rand::{random, Open01};
|
||||||
///
|
///
|
||||||
|
@ -493,7 +493,7 @@ pub struct Open01<F>(pub F);
|
||||||
/// `Rand` implementation of `f32` and `f64` for the half-open
|
/// `Rand` implementation of `f32` and `f64` for the half-open
|
||||||
/// `[0,1)`.
|
/// `[0,1)`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{random, Closed01};
|
/// use std::rand::{random, Closed01};
|
||||||
|
|
|
@ -100,7 +100,7 @@ impl<S, R: SeedableRng<S>, Rsdr: Reseeder<R> + Default>
|
||||||
|
|
||||||
/// Something that can be used to reseed an RNG via `ReseedingRng`.
|
/// Something that can be used to reseed an RNG via `ReseedingRng`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{Rng, SeedableRng, StdRng};
|
/// use std::rand::{Rng, SeedableRng, StdRng};
|
||||||
|
|
|
@ -36,7 +36,7 @@ fn combine(seek: SeekStyle, cur: uint, end: uint, offset: i64) -> IoResult<u64>
|
||||||
|
|
||||||
/// Writes to an owned, growable byte vector that supports seeking.
|
/// Writes to an owned, growable byte vector that supports seeking.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -193,7 +193,7 @@ pub fn can_reach<T, S>(edges_map: &HashMap<T, Vec<T>, S>, source: T,
|
||||||
/// ```
|
/// ```
|
||||||
/// but currently it is not possible.
|
/// but currently it is not possible.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```
|
/// ```
|
||||||
/// struct Context {
|
/// struct Context {
|
||||||
/// cache: RefCell<HashMap<uint, uint>>
|
/// cache: RefCell<HashMap<uint, uint>>
|
||||||
|
|
|
@ -29,7 +29,7 @@
|
||||||
/// The flags should only be defined for integer types, otherwise unexpected
|
/// The flags should only be defined for integer types, otherwise unexpected
|
||||||
/// type errors may occur at compile time.
|
/// type errors may occur at compile time.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```{.rust}
|
/// ```{.rust}
|
||||||
/// #[macro_use] extern crate rustc_bitflags;
|
/// #[macro_use] extern crate rustc_bitflags;
|
||||||
|
|
|
@ -29,7 +29,7 @@ const CHARS: &'static [u8] = b"0123456789abcdef";
|
||||||
impl ToHex for [u8] {
|
impl ToHex for [u8] {
|
||||||
/// Turn a vector of `u8` bytes into a hexadecimal string.
|
/// Turn a vector of `u8` bytes into a hexadecimal string.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// extern crate serialize;
|
/// extern crate serialize;
|
||||||
|
@ -96,7 +96,7 @@ impl FromHex for str {
|
||||||
/// You can use the `String::from_utf8` function to turn a
|
/// You can use the `String::from_utf8` function to turn a
|
||||||
/// `Vec<u8>` into a string with characters corresponding to those values.
|
/// `Vec<u8>` into a string with characters corresponding to those values.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// This converts a string literal to hexadecimal and back.
|
/// This converts a string literal to hexadecimal and back.
|
||||||
///
|
///
|
||||||
|
|
|
@ -225,7 +225,7 @@ fn test_resize_policy() {
|
||||||
/// 3. Emmanuel Goossaert. ["Robin Hood hashing: backward shift
|
/// 3. Emmanuel Goossaert. ["Robin Hood hashing: backward shift
|
||||||
/// deletion"](http://codecapsule.com/2013/11/17/robin-hood-hashing-backward-shift-deletion/)
|
/// deletion"](http://codecapsule.com/2013/11/17/robin-hood-hashing-backward-shift-deletion/)
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -497,7 +497,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
impl<K: Hash + Eq, V> HashMap<K, V, RandomState> {
|
impl<K: Hash + Eq, V> HashMap<K, V, RandomState> {
|
||||||
/// Create an empty HashMap.
|
/// Create an empty HashMap.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -511,7 +511,7 @@ impl<K: Hash + Eq, V> HashMap<K, V, RandomState> {
|
||||||
|
|
||||||
/// Creates an empty hash map with the given initial capacity.
|
/// Creates an empty hash map with the given initial capacity.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -531,7 +531,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
///
|
///
|
||||||
/// The creates map has the default initial capacity.
|
/// The creates map has the default initial capacity.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -559,7 +559,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// cause many collisions and very poor performance. Setting it
|
/// cause many collisions and very poor performance. Setting it
|
||||||
/// manually using this function can expose a DoS attack vector.
|
/// manually using this function can expose a DoS attack vector.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -586,7 +586,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
|
|
||||||
/// Returns the number of elements the map can hold without reallocating.
|
/// Returns the number of elements the map can hold without reallocating.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -607,7 +607,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
///
|
///
|
||||||
/// Panics if the new allocation size overflows `usize`.
|
/// Panics if the new allocation size overflows `usize`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -714,7 +714,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// down as much as possible while maintaining the internal rules
|
/// down as much as possible while maintaining the internal rules
|
||||||
/// and possibly leaving some space in accordance with the resize policy.
|
/// and possibly leaving some space in accordance with the resize policy.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -806,7 +806,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// An iterator visiting all keys in arbitrary order.
|
/// An iterator visiting all keys in arbitrary order.
|
||||||
/// Iterator element type is `&'a K`.
|
/// Iterator element type is `&'a K`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -831,7 +831,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// An iterator visiting all values in arbitrary order.
|
/// An iterator visiting all values in arbitrary order.
|
||||||
/// Iterator element type is `&'a V`.
|
/// Iterator element type is `&'a V`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -856,7 +856,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// An iterator visiting all key-value pairs in arbitrary order.
|
/// An iterator visiting all key-value pairs in arbitrary order.
|
||||||
/// Iterator element type is `(&'a K, &'a V)`.
|
/// Iterator element type is `(&'a K, &'a V)`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -879,7 +879,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// with mutable references to the values.
|
/// with mutable references to the values.
|
||||||
/// Iterator element type is `(&'a K, &'a mut V)`.
|
/// Iterator element type is `(&'a K, &'a mut V)`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -907,7 +907,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// pair out of the map in arbitrary order. The map cannot be used after
|
/// pair out of the map in arbitrary order. The map cannot be used after
|
||||||
/// calling this.
|
/// calling this.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -942,7 +942,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
|
|
||||||
/// Returns the number of elements in the map.
|
/// Returns the number of elements in the map.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -957,7 +957,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
|
|
||||||
/// Returns true if the map contains no elements.
|
/// Returns true if the map contains no elements.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -974,7 +974,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// Clears the map, returning all key-value pairs as an iterator. Keeps the
|
/// Clears the map, returning all key-value pairs as an iterator. Keeps the
|
||||||
/// allocated memory for reuse.
|
/// allocated memory for reuse.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -1005,7 +1005,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// Clears the map, removing all key-value pairs. Keeps the allocated memory
|
/// Clears the map, removing all key-value pairs. Keeps the allocated memory
|
||||||
/// for reuse.
|
/// for reuse.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -1027,7 +1027,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
||||||
/// the key type.
|
/// the key type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -1050,7 +1050,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
||||||
/// the key type.
|
/// the key type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -1073,7 +1073,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
||||||
/// the key type.
|
/// the key type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -1096,7 +1096,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// Inserts a key-value pair from the map. If the key already had a value
|
/// Inserts a key-value pair from the map. If the key already had a value
|
||||||
/// present in the map, that value is returned. Otherwise, `None` is returned.
|
/// present in the map, that value is returned. Otherwise, `None` is returned.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
@ -1128,7 +1128,7 @@ impl<K, V, S> HashMap<K, V, S>
|
||||||
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
||||||
/// the key type.
|
/// the key type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashMap;
|
/// use std::collections::HashMap;
|
||||||
|
|
|
@ -38,7 +38,7 @@ use super::state::HashState;
|
||||||
/// HashMap where the value is (). As with the `HashMap` type, a `HashSet`
|
/// HashMap where the value is (). As with the `HashMap` type, a `HashSet`
|
||||||
/// requires that the elements implement the `Eq` and `Hash` traits.
|
/// requires that the elements implement the `Eq` and `Hash` traits.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -100,7 +100,7 @@ pub struct HashSet<T, S = RandomState> {
|
||||||
impl<T: Hash + Eq> HashSet<T, RandomState> {
|
impl<T: Hash + Eq> HashSet<T, RandomState> {
|
||||||
/// Create an empty HashSet.
|
/// Create an empty HashSet.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -115,7 +115,7 @@ impl<T: Hash + Eq> HashSet<T, RandomState> {
|
||||||
/// Create an empty HashSet with space for at least `n` elements in
|
/// Create an empty HashSet with space for at least `n` elements in
|
||||||
/// the hash table.
|
/// the hash table.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -136,7 +136,7 @@ impl<T, S> HashSet<T, S>
|
||||||
///
|
///
|
||||||
/// The hash set is also created with the default initial capacity.
|
/// The hash set is also created with the default initial capacity.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -160,7 +160,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// cause many collisions and very poor performance. Setting it
|
/// cause many collisions and very poor performance. Setting it
|
||||||
/// manually using this function can expose a DoS attack vector.
|
/// manually using this function can expose a DoS attack vector.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -181,7 +181,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Returns the number of elements the set can hold without reallocating.
|
/// Returns the number of elements the set can hold without reallocating.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -202,7 +202,7 @@ impl<T, S> HashSet<T, S>
|
||||||
///
|
///
|
||||||
/// Panics if the new allocation size overflows `usize`.
|
/// Panics if the new allocation size overflows `usize`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -218,7 +218,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// down as much as possible while maintaining the internal rules
|
/// down as much as possible while maintaining the internal rules
|
||||||
/// and possibly leaving some space in accordance with the resize policy.
|
/// and possibly leaving some space in accordance with the resize policy.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -238,7 +238,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// An iterator visiting all elements in arbitrary order.
|
/// An iterator visiting all elements in arbitrary order.
|
||||||
/// Iterator element type is &'a T.
|
/// Iterator element type is &'a T.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -260,7 +260,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// of the set in arbitrary order. The set cannot be used after calling
|
/// of the set in arbitrary order. The set cannot be used after calling
|
||||||
/// this.
|
/// this.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -286,7 +286,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Visit the values representing the difference.
|
/// Visit the values representing the difference.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -316,7 +316,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Visit the values representing the symmetric difference.
|
/// Visit the values representing the symmetric difference.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -342,7 +342,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Visit the values representing the intersection.
|
/// Visit the values representing the intersection.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -367,7 +367,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Visit the values representing the union.
|
/// Visit the values representing the union.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -389,7 +389,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Return the number of elements in the set
|
/// Return the number of elements in the set
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -404,7 +404,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Returns true if the set contains no elements
|
/// Returns true if the set contains no elements
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -430,7 +430,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Clears the set, removing all values.
|
/// Clears the set, removing all values.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -449,7 +449,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
||||||
/// the value type.
|
/// the value type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -468,7 +468,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// Returns `true` if the set has no elements in common with `other`.
|
/// Returns `true` if the set has no elements in common with `other`.
|
||||||
/// This is equivalent to checking for an empty intersection.
|
/// This is equivalent to checking for an empty intersection.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -489,7 +489,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Returns `true` if the set is a subset of another.
|
/// Returns `true` if the set is a subset of another.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -510,7 +510,7 @@ impl<T, S> HashSet<T, S>
|
||||||
|
|
||||||
/// Returns `true` if the set is a superset of another.
|
/// Returns `true` if the set is a superset of another.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -536,7 +536,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// Adds a value to the set. Returns `true` if the value was not already
|
/// Adds a value to the set. Returns `true` if the value was not already
|
||||||
/// present in the set.
|
/// present in the set.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
@ -557,7 +557,7 @@ impl<T, S> HashSet<T, S>
|
||||||
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
/// `Hash` and `Eq` on the borrowed form *must* match those for
|
||||||
/// the value type.
|
/// the value type.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::collections::HashSet;
|
/// use std::collections::HashSet;
|
||||||
|
|
|
@ -38,7 +38,7 @@ use sys::os as os_imp;
|
||||||
/// * There are insufficient permissions to access the current directory.
|
/// * There are insufficient permissions to access the current directory.
|
||||||
/// * The internal buffer is not large enough to hold the path.
|
/// * The internal buffer is not large enough to hold the path.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -55,7 +55,7 @@ pub fn current_dir() -> io::Result<PathBuf> {
|
||||||
/// Changes the current working directory to the specified path, returning
|
/// Changes the current working directory to the specified path, returning
|
||||||
/// whether the change was completed successfully or not.
|
/// whether the change was completed successfully or not.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -99,7 +99,7 @@ pub struct VarsOs { inner: os_imp::Env }
|
||||||
/// environment is not valid unicode. If this is not desired, consider using the
|
/// environment is not valid unicode. If this is not desired, consider using the
|
||||||
/// `env::vars_os` function.
|
/// `env::vars_os` function.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -122,7 +122,7 @@ pub fn vars() -> Vars {
|
||||||
/// variables at the time of this invocation, modifications to environment
|
/// variables at the time of this invocation, modifications to environment
|
||||||
/// variables afterwards will not be reflected in the returned iterator.
|
/// variables afterwards will not be reflected in the returned iterator.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -163,7 +163,7 @@ impl Iterator for VarsOs {
|
||||||
/// valid unicode. If the environment variable is not present, or it is not
|
/// valid unicode. If the environment variable is not present, or it is not
|
||||||
/// valid unicode, then `Err` will be returned.
|
/// valid unicode, then `Err` will be returned.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -185,7 +185,7 @@ pub fn var<K: ?Sized>(key: &K) -> Result<String, VarError> where K: AsOsStr {
|
||||||
/// Fetches the environment variable `key` from the current process, returning
|
/// Fetches the environment variable `key` from the current process, returning
|
||||||
/// None if the variable isn't set.
|
/// None if the variable isn't set.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -243,7 +243,7 @@ impl Error for VarError {
|
||||||
/// Sets the environment variable `k` to the value `v` for the currently running
|
/// Sets the environment variable `k` to the value `v` for the currently running
|
||||||
/// process.
|
/// process.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -279,7 +279,7 @@ pub struct SplitPaths<'a> { inner: os_imp::SplitPaths<'a> }
|
||||||
///
|
///
|
||||||
/// Returns an iterator over the paths contained in `unparsed`.
|
/// Returns an iterator over the paths contained in `unparsed`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -323,7 +323,7 @@ pub struct JoinPathsError {
|
||||||
/// `Path`s contains an invalid character for constructing the `PATH`
|
/// `Path`s contains an invalid character for constructing the `PATH`
|
||||||
/// variable (a double quote on Windows or a colon on Unix).
|
/// variable (a double quote on Windows or a colon on Unix).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -371,7 +371,7 @@ impl Error for JoinPathsError {
|
||||||
/// 'USERPROFILE' environment variable if it is set and not equal to the empty
|
/// 'USERPROFILE' environment variable if it is set and not equal to the empty
|
||||||
/// string.
|
/// string.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -478,7 +478,7 @@ pub struct ArgsOs { inner: os_imp::Args }
|
||||||
/// process is not valid unicode. If this is not desired it is recommended to
|
/// process is not valid unicode. If this is not desired it is recommended to
|
||||||
/// use the `args_os` function instead.
|
/// use the `args_os` function instead.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
@ -500,7 +500,7 @@ pub fn args() -> Args {
|
||||||
/// set to arbitrary text, and it may not even exist, so this property should
|
/// set to arbitrary text, and it may not even exist, so this property should
|
||||||
/// not be relied upon for security purposes.
|
/// not be relied upon for security purposes.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::env;
|
/// use std::env;
|
||||||
|
|
|
@ -41,7 +41,7 @@ use vec::Vec;
|
||||||
/// a `CString` do *not* contain the trailing nul terminator unless otherwise
|
/// a `CString` do *not* contain the trailing nul terminator unless otherwise
|
||||||
/// specified.
|
/// specified.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # extern crate libc;
|
/// # extern crate libc;
|
||||||
|
@ -325,7 +325,7 @@ impl CStr {
|
||||||
/// > currently implemented with an up-front calculation of the length of
|
/// > currently implemented with an up-front calculation of the length of
|
||||||
/// > the string. This is not guaranteed to always be the case.
|
/// > the string. This is not guaranteed to always be the case.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # extern crate libc;
|
/// # extern crate libc;
|
||||||
|
|
|
@ -36,7 +36,7 @@ mod tempdir;
|
||||||
/// it was opened with. Files also implement `Seek` to alter the logical cursor
|
/// it was opened with. Files also implement `Seek` to alter the logical cursor
|
||||||
/// that the file contains internally.
|
/// that the file contains internally.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::io::prelude::*;
|
/// use std::io::prelude::*;
|
||||||
|
@ -392,7 +392,7 @@ impl DirEntry {
|
||||||
|
|
||||||
/// Remove a file from the underlying filesystem.
|
/// Remove a file from the underlying filesystem.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,no_run
|
/// ```rust,no_run
|
||||||
/// use std::fs;
|
/// use std::fs;
|
||||||
|
@ -420,7 +420,7 @@ pub fn remove_file<P: AsPath + ?Sized>(path: &P) -> io::Result<()> {
|
||||||
/// This function will traverse soft links to query information about the
|
/// This function will traverse soft links to query information about the
|
||||||
/// destination file.
|
/// destination file.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,no_run
|
/// ```rust,no_run
|
||||||
/// # fn foo() -> std::io::Result<()> {
|
/// # fn foo() -> std::io::Result<()> {
|
||||||
|
@ -444,7 +444,7 @@ pub fn metadata<P: AsPath + ?Sized>(path: &P) -> io::Result<Metadata> {
|
||||||
|
|
||||||
/// Rename a file or directory to a new name.
|
/// Rename a file or directory to a new name.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,no_run
|
/// ```rust,no_run
|
||||||
/// use std::fs;
|
/// use std::fs;
|
||||||
|
@ -472,7 +472,7 @@ pub fn rename<P: AsPath + ?Sized, Q: AsPath + ?Sized>(from: &P, to: &Q)
|
||||||
/// Note that if `from` and `to` both point to the same file, then the file
|
/// Note that if `from` and `to` both point to the same file, then the file
|
||||||
/// will likely get truncated by this operation.
|
/// will likely get truncated by this operation.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::fs;
|
/// use std::fs;
|
||||||
|
@ -541,7 +541,7 @@ pub fn read_link<P: AsPath + ?Sized>(path: &P) -> io::Result<PathBuf> {
|
||||||
|
|
||||||
/// Create a new, empty directory at the provided path
|
/// Create a new, empty directory at the provided path
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::fs;
|
/// use std::fs;
|
||||||
|
@ -587,7 +587,7 @@ pub fn create_dir_all<P: AsPath + ?Sized>(path: &P) -> io::Result<()> {
|
||||||
|
|
||||||
/// Remove an existing, empty directory
|
/// Remove an existing, empty directory
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::fs;
|
/// use std::fs;
|
||||||
|
@ -638,7 +638,7 @@ pub fn remove_dir_all<P: AsPath + ?Sized>(path: &P) -> io::Result<()> {
|
||||||
/// The iterator will yield instances of `io::Result<DirEntry>`. New errors may
|
/// The iterator will yield instances of `io::Result<DirEntry>`. New errors may
|
||||||
/// be encountered after an iterator is initially constructed.
|
/// be encountered after an iterator is initially constructed.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::io;
|
/// use std::io;
|
||||||
|
@ -776,7 +776,7 @@ pub fn set_file_times<P: AsPath + ?Sized>(path: &P, accessed: u64,
|
||||||
|
|
||||||
/// Changes the permissions found on a file or a directory.
|
/// Changes the permissions found on a file or a directory.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # fn foo() -> std::io::Result<()> {
|
/// # fn foo() -> std::io::Result<()> {
|
||||||
|
|
|
@ -26,7 +26,7 @@
|
||||||
/// The multi-argument form of this macro panics with a string and has the
|
/// The multi-argument form of this macro panics with a string and has the
|
||||||
/// `format!` syntax for building a string.
|
/// `format!` syntax for building a string.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```should_fail
|
/// ```should_fail
|
||||||
/// # #![allow(unreachable_code)]
|
/// # #![allow(unreachable_code)]
|
||||||
|
@ -74,7 +74,7 @@ macro_rules! print {
|
||||||
/// The syntax of this macro is the same as that used for `format!`. For more
|
/// The syntax of this macro is the same as that used for `format!`. For more
|
||||||
/// information, see `std::fmt` and `std::old_io::stdio`.
|
/// information, see `std::fmt` and `std::old_io::stdio`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// println!("hello there!");
|
/// println!("hello there!");
|
||||||
|
@ -177,7 +177,7 @@ pub mod builtin {
|
||||||
///
|
///
|
||||||
/// For more information, see the documentation in `std::fmt`.
|
/// For more information, see the documentation in `std::fmt`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::fmt;
|
/// use std::fmt;
|
||||||
|
@ -200,7 +200,7 @@ pub mod builtin {
|
||||||
/// will be emitted. To not emit a compile error, use the `option_env!`
|
/// will be emitted. To not emit a compile error, use the `option_env!`
|
||||||
/// macro instead.
|
/// macro instead.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let path: &'static str = env!("PATH");
|
/// let path: &'static str = env!("PATH");
|
||||||
|
@ -219,7 +219,7 @@ pub mod builtin {
|
||||||
/// A compile time error is never emitted when using this macro regardless
|
/// A compile time error is never emitted when using this macro regardless
|
||||||
/// of whether the environment variable is present or not.
|
/// of whether the environment variable is present or not.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let key: Option<&'static str> = option_env!("SECRET_KEY");
|
/// let key: Option<&'static str> = option_env!("SECRET_KEY");
|
||||||
|
@ -263,7 +263,7 @@ pub mod builtin {
|
||||||
/// Integer and floating point literals are stringified in order to be
|
/// Integer and floating point literals are stringified in order to be
|
||||||
/// concatenated.
|
/// concatenated.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let s = concat!("test", 10, 'b', true);
|
/// let s = concat!("test", 10, 'b', true);
|
||||||
|
@ -278,7 +278,7 @@ pub mod builtin {
|
||||||
/// the invocation of the `line!()` macro itself, but rather the first macro
|
/// the invocation of the `line!()` macro itself, but rather the first macro
|
||||||
/// invocation leading up to the invocation of the `line!()` macro.
|
/// invocation leading up to the invocation of the `line!()` macro.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let current_line = line!();
|
/// let current_line = line!();
|
||||||
|
@ -293,7 +293,7 @@ pub mod builtin {
|
||||||
/// the invocation of the `column!()` macro itself, but rather the first macro
|
/// the invocation of the `column!()` macro itself, but rather the first macro
|
||||||
/// invocation leading up to the invocation of the `column!()` macro.
|
/// invocation leading up to the invocation of the `column!()` macro.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let current_col = column!();
|
/// let current_col = column!();
|
||||||
|
@ -309,7 +309,7 @@ pub mod builtin {
|
||||||
/// first macro invocation leading up to the invocation of the `file!()`
|
/// first macro invocation leading up to the invocation of the `file!()`
|
||||||
/// macro.
|
/// macro.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let this_file = file!();
|
/// let this_file = file!();
|
||||||
|
@ -324,7 +324,7 @@ pub mod builtin {
|
||||||
/// stringification of all the tokens passed to the macro. No restrictions
|
/// stringification of all the tokens passed to the macro. No restrictions
|
||||||
/// are placed on the syntax of the macro invocation itself.
|
/// are placed on the syntax of the macro invocation itself.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let one_plus_one = stringify!(1 + 1);
|
/// let one_plus_one = stringify!(1 + 1);
|
||||||
|
@ -339,7 +339,7 @@ pub mod builtin {
|
||||||
/// contents of the filename specified. The file is located relative to the
|
/// contents of the filename specified. The file is located relative to the
|
||||||
/// current file (similarly to how modules are found),
|
/// current file (similarly to how modules are found),
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,ignore
|
/// ```rust,ignore
|
||||||
/// let secret_key = include_str!("secret-key.ascii");
|
/// let secret_key = include_str!("secret-key.ascii");
|
||||||
|
@ -353,7 +353,7 @@ pub mod builtin {
|
||||||
/// the contents of the filename specified. The file is located relative to
|
/// the contents of the filename specified. The file is located relative to
|
||||||
/// the current file (similarly to how modules are found),
|
/// the current file (similarly to how modules are found),
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,ignore
|
/// ```rust,ignore
|
||||||
/// let secret_key = include_bytes!("secret-key.bin");
|
/// let secret_key = include_bytes!("secret-key.bin");
|
||||||
|
@ -367,7 +367,7 @@ pub mod builtin {
|
||||||
/// leading back up to the crate root. The first component of the path
|
/// leading back up to the crate root. The first component of the path
|
||||||
/// returned is the name of the crate currently being compiled.
|
/// returned is the name of the crate currently being compiled.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// mod test {
|
/// mod test {
|
||||||
|
@ -390,7 +390,7 @@ pub mod builtin {
|
||||||
/// The syntax given to this macro is the same syntax as the `cfg`
|
/// The syntax given to this macro is the same syntax as the `cfg`
|
||||||
/// attribute.
|
/// attribute.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// let my_directory = if cfg!(windows) {
|
/// let my_directory = if cfg!(windows) {
|
||||||
|
|
|
@ -82,7 +82,7 @@ impl Iterator for LookupHost {
|
||||||
/// This method may perform a DNS query to resolve `host` and may also inspect
|
/// This method may perform a DNS query to resolve `host` and may also inspect
|
||||||
/// system configuration to resolve the specified hostname.
|
/// system configuration to resolve the specified hostname.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::net;
|
/// use std::net;
|
||||||
|
|
|
@ -21,7 +21,7 @@ use sys_common::AsInner;
|
||||||
///
|
///
|
||||||
/// The socket will be closed when the value is dropped.
|
/// The socket will be closed when the value is dropped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::io::prelude::*;
|
/// use std::io::prelude::*;
|
||||||
|
|
|
@ -21,7 +21,7 @@ use sys_common::AsInner;
|
||||||
/// IPv6 addresses, and there is no corresponding notion of a server because UDP
|
/// IPv6 addresses, and there is no corresponding notion of a server because UDP
|
||||||
/// is a datagram protocol.
|
/// is a datagram protocol.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::net::UdpSocket;
|
/// use std::net::UdpSocket;
|
||||||
|
|
|
@ -31,7 +31,7 @@ use vec::Vec;
|
||||||
/// `BufferedReader` performs large, infrequent reads on the underlying
|
/// `BufferedReader` performs large, infrequent reads on the underlying
|
||||||
/// `Reader` and maintains an in-memory buffer of the results.
|
/// `Reader` and maintains an in-memory buffer of the results.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::{BufferedReader, File};
|
/// use std::old_io::{BufferedReader, File};
|
||||||
|
@ -134,7 +134,7 @@ impl<R: Reader> Reader for BufferedReader<R> {
|
||||||
///
|
///
|
||||||
/// This writer will be flushed when it is dropped.
|
/// This writer will be flushed when it is dropped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::{BufferedWriter, File};
|
/// use std::old_io::{BufferedWriter, File};
|
||||||
|
@ -320,7 +320,7 @@ impl<W: Reader> Reader for InternalBufferedWriter<W> {
|
||||||
///
|
///
|
||||||
/// The output half will be flushed when this stream is dropped.
|
/// The output half will be flushed when this stream is dropped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -20,7 +20,7 @@ use vec::Vec;
|
||||||
|
|
||||||
/// Allows reading from a rx.
|
/// Allows reading from a rx.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::mpsc::channel;
|
/// use std::sync::mpsc::channel;
|
||||||
|
@ -111,7 +111,7 @@ impl Reader for ChanReader {
|
||||||
|
|
||||||
/// Allows writing to a tx.
|
/// Allows writing to a tx.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -27,7 +27,7 @@
|
||||||
//! the metadata of a file. This includes getting the `stat` information,
|
//! the metadata of a file. This includes getting the `stat` information,
|
||||||
//! reading off particular bits of it, etc.
|
//! reading off particular bits of it, etc.
|
||||||
//!
|
//!
|
||||||
//! # Example
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! ```rust
|
//! ```rust
|
||||||
//! # #![allow(unused_must_use)]
|
//! # #![allow(unused_must_use)]
|
||||||
|
@ -102,7 +102,7 @@ impl File {
|
||||||
/// Open a file at `path` in the mode specified by the `mode` and `access`
|
/// Open a file at `path` in the mode specified by the `mode` and `access`
|
||||||
/// arguments
|
/// arguments
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,should_fail
|
/// ```rust,should_fail
|
||||||
/// use std::old_io::{File, Open, ReadWrite};
|
/// use std::old_io::{File, Open, ReadWrite};
|
||||||
|
@ -173,7 +173,7 @@ impl File {
|
||||||
///
|
///
|
||||||
/// For more information, see the `File::open_mode` function.
|
/// For more information, see the `File::open_mode` function.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::File;
|
/// use std::old_io::File;
|
||||||
|
@ -192,7 +192,7 @@ impl File {
|
||||||
///
|
///
|
||||||
/// For more information, see the `File::open_mode` function.
|
/// For more information, see the `File::open_mode` function.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -283,7 +283,7 @@ impl File {
|
||||||
|
|
||||||
/// Unlink a file from the underlying filesystem.
|
/// Unlink a file from the underlying filesystem.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -314,7 +314,7 @@ pub fn unlink(path: &Path) -> IoResult<()> {
|
||||||
/// directory, etc. This function will traverse symlinks to query
|
/// directory, etc. This function will traverse symlinks to query
|
||||||
/// information about the destination file.
|
/// information about the destination file.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::fs;
|
/// use std::old_io::fs;
|
||||||
|
@ -356,7 +356,7 @@ pub fn lstat(path: &Path) -> IoResult<FileStat> {
|
||||||
|
|
||||||
/// Rename a file or directory to a new name.
|
/// Rename a file or directory to a new name.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -384,7 +384,7 @@ pub fn rename(from: &Path, to: &Path) -> IoResult<()> {
|
||||||
/// Note that if `from` and `to` both point to the same file, then the file
|
/// Note that if `from` and `to` both point to the same file, then the file
|
||||||
/// will likely get truncated by this operation.
|
/// will likely get truncated by this operation.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -434,7 +434,7 @@ pub fn copy(from: &Path, to: &Path) -> IoResult<()> {
|
||||||
/// Changes the permission mode bits found on a file or a directory. This
|
/// Changes the permission mode bits found on a file or a directory. This
|
||||||
/// function takes a mask from the `io` module
|
/// function takes a mask from the `io` module
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -505,7 +505,7 @@ pub fn readlink(path: &Path) -> IoResult<Path> {
|
||||||
|
|
||||||
/// Create a new, empty directory at the provided path
|
/// Create a new, empty directory at the provided path
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -529,7 +529,7 @@ pub fn mkdir(path: &Path, mode: FilePermission) -> IoResult<()> {
|
||||||
|
|
||||||
/// Remove an existing, empty directory
|
/// Remove an existing, empty directory
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -553,7 +553,7 @@ pub fn rmdir(path: &Path) -> IoResult<()> {
|
||||||
|
|
||||||
/// Retrieve a vector containing all entries within a provided directory
|
/// Retrieve a vector containing all entries within a provided directory
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::fs::PathExtensions;
|
/// use std::old_io::fs::PathExtensions;
|
||||||
|
|
|
@ -51,7 +51,7 @@ impl Writer for Vec<u8> {
|
||||||
|
|
||||||
/// Writes to an owned, growable byte vector
|
/// Writes to an owned, growable byte vector
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -111,7 +111,7 @@ impl Writer for MemWriter {
|
||||||
|
|
||||||
/// Reads from an owned byte vector
|
/// Reads from an owned byte vector
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -241,7 +241,7 @@ impl<'a> Buffer for &'a [u8] {
|
||||||
/// If a write will not fit in the buffer, it returns an error and does not
|
/// If a write will not fit in the buffer, it returns an error and does not
|
||||||
/// write any data.
|
/// write any data.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -313,7 +313,7 @@ impl<'a> Seek for BufWriter<'a> {
|
||||||
|
|
||||||
/// Reads from a fixed-size byte slice
|
/// Reads from a fixed-size byte slice
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -1276,7 +1276,7 @@ impl<'a> Writer for &'a mut (Writer+'a) {
|
||||||
/// A `RefWriter` is a struct implementing `Writer` which contains a reference
|
/// A `RefWriter` is a struct implementing `Writer` which contains a reference
|
||||||
/// to another writer. This is often useful when composing streams.
|
/// to another writer. This is often useful when composing streams.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::old_io::util::TeeReader;
|
/// use std::old_io::util::TeeReader;
|
||||||
|
@ -1401,7 +1401,7 @@ pub trait Buffer: Reader {
|
||||||
/// encoded Unicode codepoints. If a newline is encountered, then the
|
/// encoded Unicode codepoints. If a newline is encountered, then the
|
||||||
/// newline is contained in the returned string.
|
/// newline is contained in the returned string.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::BufReader;
|
/// use std::old_io::BufReader;
|
||||||
|
@ -1625,7 +1625,7 @@ impl<'a, T, A: ?Sized + Acceptor<T>> Iterator for IncomingConnections<'a, A> {
|
||||||
/// Creates a standard error for a commonly used flavor of error. The `detail`
|
/// Creates a standard error for a commonly used flavor of error. The `detail`
|
||||||
/// field of the returned error will always be `None`.
|
/// field of the returned error will always be `None`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::old_io as io;
|
/// use std::old_io as io;
|
||||||
|
|
|
@ -50,7 +50,7 @@ impl UnixStream {
|
||||||
///
|
///
|
||||||
/// The returned stream will be closed when the object falls out of scope.
|
/// The returned stream will be closed when the object falls out of scope.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -175,7 +175,7 @@ impl UnixListener {
|
||||||
///
|
///
|
||||||
/// This listener will be closed when it falls out of scope.
|
/// This listener will be closed when it falls out of scope.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # fn foo() {
|
/// # fn foo() {
|
||||||
|
|
|
@ -38,7 +38,7 @@ use sys_common;
|
||||||
///
|
///
|
||||||
/// The socket will be closed when the value is dropped.
|
/// The socket will be closed when the value is dropped.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::old_io::TcpStream;
|
/// use std::old_io::TcpStream;
|
||||||
|
@ -130,7 +130,7 @@ impl TcpStream {
|
||||||
/// This method will close the reading portion of this connection, causing
|
/// This method will close the reading portion of this connection, causing
|
||||||
/// all pending and future reads to immediately return with an error.
|
/// all pending and future reads to immediately return with an error.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
@ -373,7 +373,7 @@ impl TcpAcceptor {
|
||||||
/// regardless of whether the timeout has expired or not (the accept will
|
/// regardless of whether the timeout has expired or not (the accept will
|
||||||
/// not block in this case).
|
/// not block in this case).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::old_io::TcpListener;
|
/// use std::old_io::TcpListener;
|
||||||
|
@ -417,7 +417,7 @@ impl TcpAcceptor {
|
||||||
/// This is useful for waking up a thread in an accept loop to indicate that
|
/// This is useful for waking up a thread in an accept loop to indicate that
|
||||||
/// it should exit.
|
/// it should exit.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::old_io::{TcpListener, Listener, Acceptor, EndOfFile};
|
/// use std::old_io::{TcpListener, Listener, Acceptor, EndOfFile};
|
||||||
|
|
|
@ -28,7 +28,7 @@ use sys_common;
|
||||||
/// IPv6 addresses, and there is no corresponding notion of a server because UDP
|
/// IPv6 addresses, and there is no corresponding notion of a server because UDP
|
||||||
/// is a datagram protocol.
|
/// is a datagram protocol.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,no_run
|
/// ```rust,no_run
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -43,7 +43,7 @@ impl PipeStream {
|
||||||
/// This operation consumes ownership of the file descriptor and it will be
|
/// This operation consumes ownership of the file descriptor and it will be
|
||||||
/// closed once the object is deallocated.
|
/// closed once the object is deallocated.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```{rust,no_run}
|
/// ```{rust,no_run}
|
||||||
/// # #![allow(unused_must_use)]
|
/// # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -57,7 +57,7 @@ use thread;
|
||||||
/// process is created via the `Command` struct, which configures the spawning
|
/// process is created via the `Command` struct, which configures the spawning
|
||||||
/// process and can itself be constructed using a builder-style interface.
|
/// process and can itself be constructed using a builder-style interface.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```should_fail
|
/// ```should_fail
|
||||||
/// use std::old_io::Command;
|
/// use std::old_io::Command;
|
||||||
|
@ -361,7 +361,7 @@ impl Command {
|
||||||
/// Executes the command as a child process, waiting for it to finish and
|
/// Executes the command as a child process, waiting for it to finish and
|
||||||
/// collecting all of its output.
|
/// collecting all of its output.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::old_io::Command;
|
/// use std::old_io::Command;
|
||||||
|
@ -382,7 +382,7 @@ impl Command {
|
||||||
/// Executes a command as a child process, waiting for it to finish and
|
/// Executes a command as a child process, waiting for it to finish and
|
||||||
/// collecting its exit status.
|
/// collecting its exit status.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::old_io::Command;
|
/// use std::old_io::Command;
|
||||||
|
@ -656,7 +656,7 @@ impl Process {
|
||||||
/// A value of `None` will clear any previous timeout, and a value of `Some`
|
/// A value of `None` will clear any previous timeout, and a value of `Some`
|
||||||
/// will override any previously set timeout.
|
/// will override any previously set timeout.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::old_io::{Command, IoResult};
|
/// use std::old_io::{Command, IoResult};
|
||||||
|
|
|
@ -15,7 +15,7 @@
|
||||||
//! inspected for information about terminal dimensions or for related information
|
//! inspected for information about terminal dimensions or for related information
|
||||||
//! about the stream or terminal to which it is attached.
|
//! about the stream or terminal to which it is attached.
|
||||||
//!
|
//!
|
||||||
//! # Example
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! ```rust
|
//! ```rust
|
||||||
//! # #![allow(unused_must_use)]
|
//! # #![allow(unused_must_use)]
|
||||||
|
|
|
@ -113,7 +113,7 @@ impl Timer {
|
||||||
/// invalidated at the end of that statement, and all `recv` calls will
|
/// invalidated at the end of that statement, and all `recv` calls will
|
||||||
/// fail.
|
/// fail.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::Timer;
|
/// use std::old_io::Timer;
|
||||||
|
@ -165,7 +165,7 @@ impl Timer {
|
||||||
/// invalidated at the end of that statement, and all `recv` calls will
|
/// invalidated at the end of that statement, and all `recv` calls will
|
||||||
/// fail.
|
/// fail.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::old_io::Timer;
|
/// use std::old_io::Timer;
|
||||||
|
|
|
@ -46,7 +46,7 @@
|
||||||
//! suitable for passing to any API that actually operates on the path; it is only intended for
|
//! suitable for passing to any API that actually operates on the path; it is only intended for
|
||||||
//! display.
|
//! display.
|
||||||
//!
|
//!
|
||||||
//! ## Example
|
//! ## Examples
|
||||||
//!
|
//!
|
||||||
//! ```rust
|
//! ```rust
|
||||||
//! use std::old_io::fs::PathExtensions;
|
//! use std::old_io::fs::PathExtensions;
|
||||||
|
@ -140,7 +140,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Creates a new Path from a byte vector or string.
|
/// Creates a new Path from a byte vector or string.
|
||||||
/// The resulting Path will always be normalized.
|
/// The resulting Path will always be normalized.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -164,7 +164,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Creates a new Path from a byte vector or string, if possible.
|
/// Creates a new Path from a byte vector or string, if possible.
|
||||||
/// The resulting Path will always be normalized.
|
/// The resulting Path will always be normalized.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -186,7 +186,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns the path as a string, if possible.
|
/// Returns the path as a string, if possible.
|
||||||
/// If the path is not representable in utf-8, this returns None.
|
/// If the path is not representable in utf-8, this returns None.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -203,7 +203,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
|
|
||||||
/// Returns the path as a byte vector
|
/// Returns the path as a byte vector
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -217,7 +217,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
|
|
||||||
/// Converts the Path into an owned byte vector
|
/// Converts the Path into an owned byte vector
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -232,7 +232,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
|
|
||||||
/// Returns an object that implements `Display` for printing paths
|
/// Returns an object that implements `Display` for printing paths
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -250,7 +250,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
///
|
///
|
||||||
/// If there is no filename, nothing will be printed.
|
/// If there is no filename, nothing will be printed.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -267,7 +267,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns the directory component of `self`, as a byte vector (with no trailing separator).
|
/// Returns the directory component of `self`, as a byte vector (with no trailing separator).
|
||||||
/// If `self` has no directory component, returns ['.'].
|
/// If `self` has no directory component, returns ['.'].
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -282,7 +282,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns the directory component of `self`, as a string, if possible.
|
/// Returns the directory component of `self`, as a string, if possible.
|
||||||
/// See `dirname` for details.
|
/// See `dirname` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -301,7 +301,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// If `self` represents the root of the file hierarchy, returns None.
|
/// If `self` represents the root of the file hierarchy, returns None.
|
||||||
/// If `self` is "." or "..", returns None.
|
/// If `self` is "." or "..", returns None.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -316,7 +316,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns the file component of `self`, as a string, if possible.
|
/// Returns the file component of `self`, as a string, if possible.
|
||||||
/// See `filename` for details.
|
/// See `filename` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -335,7 +335,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// The stem is the portion of the filename just before the last '.'.
|
/// The stem is the portion of the filename just before the last '.'.
|
||||||
/// If there is no '.', the entire filename is returned.
|
/// If there is no '.', the entire filename is returned.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -362,7 +362,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns the stem of the filename of `self`, as a string, if possible.
|
/// Returns the stem of the filename of `self`, as a string, if possible.
|
||||||
/// See `filestem` for details.
|
/// See `filestem` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -382,7 +382,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// If there is no extension, None is returned.
|
/// If there is no extension, None is returned.
|
||||||
/// If the filename ends in '.', the empty vector is returned.
|
/// If the filename ends in '.', the empty vector is returned.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -409,7 +409,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns the extension of the filename of `self`, as a string, if possible.
|
/// Returns the extension of the filename of `self`, as a string, if possible.
|
||||||
/// See `extension` for details.
|
/// See `extension` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -427,7 +427,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Replaces the filename portion of the path with the given byte vector or string.
|
/// Replaces the filename portion of the path with the given byte vector or string.
|
||||||
/// If the replacement name is [], this is equivalent to popping the path.
|
/// If the replacement name is [], this is equivalent to popping the path.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -453,7 +453,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// If the argument is [] or "", this removes the extension.
|
/// If the argument is [] or "", this removes the extension.
|
||||||
/// If `self` has no filename, this is a no-op.
|
/// If `self` has no filename, this is a no-op.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -503,7 +503,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// byte vector or string.
|
/// byte vector or string.
|
||||||
/// See `set_filename` for details.
|
/// See `set_filename` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -528,7 +528,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// byte vector or string.
|
/// byte vector or string.
|
||||||
/// See `set_extension` for details.
|
/// See `set_extension` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -552,7 +552,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns the directory component of `self`, as a Path.
|
/// Returns the directory component of `self`, as a Path.
|
||||||
/// If `self` represents the root of the filesystem hierarchy, returns `self`.
|
/// If `self` represents the root of the filesystem hierarchy, returns `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -571,7 +571,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
///
|
///
|
||||||
/// If `self` is not absolute, or vol/cwd-relative in the case of Windows, this returns None.
|
/// If `self` is not absolute, or vol/cwd-relative in the case of Windows, this returns None.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -586,7 +586,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Pushes a path (as a byte vector or string) onto `self`.
|
/// Pushes a path (as a byte vector or string) onto `self`.
|
||||||
/// If the argument represents an absolute path, it replaces `self`.
|
/// If the argument represents an absolute path, it replaces `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -610,7 +610,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Pushes multiple paths (as byte vectors or strings) onto `self`.
|
/// Pushes multiple paths (as byte vectors or strings) onto `self`.
|
||||||
/// See `push` for details.
|
/// See `push` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -639,7 +639,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// Returns `true` if the receiver was modified, or `false` if it already
|
/// Returns `true` if the receiver was modified, or `false` if it already
|
||||||
/// represented the root of the file hierarchy.
|
/// represented the root of the file hierarchy.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -656,7 +656,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// (as a byte vector or string).
|
/// (as a byte vector or string).
|
||||||
/// If the given path is absolute, the new Path will represent just that.
|
/// If the given path is absolute, the new Path will represent just that.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -681,7 +681,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// (as byte vectors or strings).
|
/// (as byte vectors or strings).
|
||||||
/// See `join` for details.
|
/// See `join` for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -703,7 +703,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// An absolute path is defined as one that, when joined to another path, will
|
/// An absolute path is defined as one that, when joined to another path, will
|
||||||
/// yield back the same absolute path.
|
/// yield back the same absolute path.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -720,7 +720,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// But for Windows paths, it also means the path is not volume-relative or
|
/// But for Windows paths, it also means the path is not volume-relative or
|
||||||
/// relative to the current working directory.
|
/// relative to the current working directory.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -738,7 +738,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// If both paths are relative, they are compared as though they are relative
|
/// If both paths are relative, they are compared as though they are relative
|
||||||
/// to the same parent path.
|
/// to the same parent path.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -757,7 +757,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
/// If `self` is absolute and `base` is relative, or on Windows if both
|
/// If `self` is absolute and `base` is relative, or on Windows if both
|
||||||
/// paths refer to separate drives, an absolute path is returned.
|
/// paths refer to separate drives, an absolute path is returned.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
@ -773,7 +773,7 @@ pub trait GenericPath: Clone + GenericPathUnsafe {
|
||||||
|
|
||||||
/// Returns whether the relative path `child` is a suffix of `self`.
|
/// Returns whether the relative path `child` is a suffix of `self`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # foo();
|
/// # foo();
|
||||||
|
|
|
@ -603,7 +603,7 @@ impl Path {
|
||||||
///
|
///
|
||||||
/// Panics if the vector contains a `NUL`, or if it contains invalid UTF-8.
|
/// Panics if the vector contains a `NUL`, or if it contains invalid UTF-8.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// println!("{}", Path::new(r"C:\some\path").display());
|
/// println!("{}", Path::new(r"C:\some\path").display());
|
||||||
|
@ -617,7 +617,7 @@ impl Path {
|
||||||
///
|
///
|
||||||
/// Returns `None` if the vector contains a `NUL`, or if it contains invalid UTF-8.
|
/// Returns `None` if the vector contains a `NUL`, or if it contains invalid UTF-8.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// let path = Path::new_opt(r"C:\some\path");
|
/// let path = Path::new_opt(r"C:\some\path");
|
||||||
|
|
|
@ -121,7 +121,7 @@ pub const TMPBUF_SZ : uint = 1000;
|
||||||
/// * There are insufficient permissions to access the current directory.
|
/// * There are insufficient permissions to access the current directory.
|
||||||
/// * The internal buffer is not large enough to hold the path.
|
/// * The internal buffer is not large enough to hold the path.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
@ -141,7 +141,7 @@ pub fn getcwd() -> IoResult<Path> {
|
||||||
/// Invalid UTF-8 bytes are replaced with \uFFFD. See `String::from_utf8_lossy()`
|
/// Invalid UTF-8 bytes are replaced with \uFFFD. See `String::from_utf8_lossy()`
|
||||||
/// for details.
|
/// for details.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
@ -177,7 +177,7 @@ pub fn env_as_bytes() -> Vec<(Vec<u8>, Vec<u8>)> {
|
||||||
///
|
///
|
||||||
/// Panics if `n` has any interior NULs.
|
/// Panics if `n` has any interior NULs.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
@ -219,7 +219,7 @@ fn byteify(s: OsString) -> Vec<u8> {
|
||||||
/// Sets the environment variable `n` to the value `v` for the currently running
|
/// Sets the environment variable `n` to the value `v` for the currently running
|
||||||
/// process.
|
/// process.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
@ -260,7 +260,7 @@ pub fn unsetenv(n: &str) {
|
||||||
/// Parses input according to platform conventions for the `PATH`
|
/// Parses input according to platform conventions for the `PATH`
|
||||||
/// environment variable.
|
/// environment variable.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
///
|
///
|
||||||
|
@ -291,7 +291,7 @@ pub fn split_paths<T: BytesContainer>(unparsed: T) -> Vec<Path> {
|
||||||
/// `Path`s contains an invalid character for constructing the `PATH`
|
/// `Path`s contains an invalid character for constructing the `PATH`
|
||||||
/// variable (a double quote on Windows or a colon on Unix).
|
/// variable (a double quote on Windows or a colon on Unix).
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
@ -372,7 +372,7 @@ pub fn self_exe_name() -> Option<Path> {
|
||||||
///
|
///
|
||||||
/// Like self_exe_name() but without the binary's name.
|
/// Like self_exe_name() but without the binary's name.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
@ -401,7 +401,7 @@ pub fn self_exe_path() -> Option<Path> {
|
||||||
/// 'USERPROFILE' environment variable if it is set and not equal to the empty
|
/// 'USERPROFILE' environment variable if it is set and not equal to the empty
|
||||||
/// string.
|
/// string.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
@ -491,7 +491,7 @@ pub fn tmpdir() -> Path {
|
||||||
/// directory. If the given path is already an absolute path, return it
|
/// directory. If the given path is already an absolute path, return it
|
||||||
/// as is.
|
/// as is.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
/// use std::old_path::Path;
|
/// use std::old_path::Path;
|
||||||
|
@ -522,7 +522,7 @@ pub fn make_absolute(p: &Path) -> IoResult<Path> {
|
||||||
/// Changes the current working directory to the specified path, returning
|
/// Changes the current working directory to the specified path, returning
|
||||||
/// whether the change was completed successfully or not.
|
/// whether the change was completed successfully or not.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
/// use std::old_path::Path;
|
/// use std::old_path::Path;
|
||||||
|
@ -543,7 +543,7 @@ pub fn errno() -> i32 {
|
||||||
|
|
||||||
/// Return the string corresponding to an `errno()` value of `errnum`.
|
/// Return the string corresponding to an `errno()` value of `errnum`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
///
|
///
|
||||||
|
@ -739,7 +739,7 @@ extern "system" {
|
||||||
///
|
///
|
||||||
/// The arguments are interpreted as utf-8, with invalid bytes replaced with \uFFFD.
|
/// The arguments are interpreted as utf-8, with invalid bytes replaced with \uFFFD.
|
||||||
/// See `String::from_utf8_lossy` for details.
|
/// See `String::from_utf8_lossy` for details.
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::os;
|
/// use std::os;
|
||||||
|
|
|
@ -809,7 +809,7 @@ impl<'a> cmp::Ord for Components<'a> {
|
||||||
/// More details about the overall approach can be found in
|
/// More details about the overall approach can be found in
|
||||||
/// the module documentation.
|
/// the module documentation.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::path::PathBuf;
|
/// use std::path::PathBuf;
|
||||||
|
@ -1041,7 +1041,7 @@ impl AsOsStr for PathBuf {
|
||||||
/// This is an *unsized* type, meaning that it must always be used with behind a
|
/// This is an *unsized* type, meaning that it must always be used with behind a
|
||||||
/// pointer like `&` or `Box`.
|
/// pointer like `&` or `Box`.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::path::Path;
|
/// use std::path::Path;
|
||||||
|
|
|
@ -35,7 +35,7 @@ use thread;
|
||||||
/// process is created via the `Command` struct, which configures the spawning
|
/// process is created via the `Command` struct, which configures the spawning
|
||||||
/// process and can itself be constructed using a builder-style interface.
|
/// process and can itself be constructed using a builder-style interface.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```should_fail
|
/// ```should_fail
|
||||||
/// # #![feature(process)]
|
/// # #![feature(process)]
|
||||||
|
@ -288,7 +288,7 @@ impl Command {
|
||||||
///
|
///
|
||||||
/// By default, stdin, stdout and stderr are inherited by the parent.
|
/// By default, stdin, stdout and stderr are inherited by the parent.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// # #![feature(process)]
|
/// # #![feature(process)]
|
||||||
|
|
|
@ -424,7 +424,7 @@ pub fn random<T: Rand>() -> T {
|
||||||
|
|
||||||
/// Randomly sample up to `amount` elements from an iterator.
|
/// Randomly sample up to `amount` elements from an iterator.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{thread_rng, sample};
|
/// use std::rand::{thread_rng, sample};
|
||||||
|
|
|
@ -22,7 +22,7 @@ use slice::SliceExt;
|
||||||
///
|
///
|
||||||
/// It will panic if it there is insufficient data to fulfill a request.
|
/// It will panic if it there is insufficient data to fulfill a request.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::rand::{reader, Rng};
|
/// use std::rand::{reader, Rng};
|
||||||
|
|
|
@ -34,7 +34,7 @@ use sync::{mutex, MutexGuard, PoisonError};
|
||||||
/// in a runtime panic. If this is not desired, then the unsafe primitives in
|
/// in a runtime panic. If this is not desired, then the unsafe primitives in
|
||||||
/// `sys` do not have this restriction but may result in undefined behavior.
|
/// `sys` do not have this restriction but may result in undefined behavior.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::{Arc, Mutex, Condvar};
|
/// use std::sync::{Arc, Mutex, Condvar};
|
||||||
|
@ -66,7 +66,7 @@ pub struct Condvar { inner: Box<StaticCondvar> }
|
||||||
/// This structure is identical to `Condvar` except that it is suitable for use
|
/// This structure is identical to `Condvar` except that it is suitable for use
|
||||||
/// in static initializers for other structures.
|
/// in static initializers for other structures.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::{StaticCondvar, CONDVAR_INIT};
|
/// use std::sync::{StaticCondvar, CONDVAR_INIT};
|
||||||
|
|
|
@ -464,7 +464,7 @@ impl<T> UnsafeFlavor<T> for Receiver<T> {
|
||||||
/// All data sent on the sender will become available on the receiver, and no
|
/// All data sent on the sender will become available on the receiver, and no
|
||||||
/// send will block the calling task (this channel has an "infinite buffer").
|
/// send will block the calling task (this channel has an "infinite buffer").
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::mpsc::channel;
|
/// use std::sync::mpsc::channel;
|
||||||
|
@ -506,7 +506,7 @@ pub fn channel<T: Send>() -> (Sender<T>, Receiver<T>) {
|
||||||
/// As with asynchronous channels, all senders will panic in `send` if the
|
/// As with asynchronous channels, all senders will panic in `send` if the
|
||||||
/// `Receiver` has been destroyed.
|
/// `Receiver` has been destroyed.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::mpsc::sync_channel;
|
/// use std::sync::mpsc::sync_channel;
|
||||||
|
@ -555,7 +555,7 @@ impl<T: Send> Sender<T> {
|
||||||
///
|
///
|
||||||
/// This method will never block the current thread.
|
/// This method will never block the current thread.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::mpsc::channel;
|
/// use std::sync::mpsc::channel;
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
//! received values of receivers in a much more natural syntax then usage of the
|
//! received values of receivers in a much more natural syntax then usage of the
|
||||||
//! `Select` structure directly.
|
//! `Select` structure directly.
|
||||||
//!
|
//!
|
||||||
//! # Example
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! ```rust
|
//! ```rust
|
||||||
//! use std::sync::mpsc::channel;
|
//! use std::sync::mpsc::channel;
|
||||||
|
|
|
@ -133,7 +133,7 @@ unsafe impl<T: Send> Sync for Mutex<T> { }
|
||||||
/// to a `Mutex`, a `destroy` method. This method is unsafe to call, and
|
/// to a `Mutex`, a `destroy` method. This method is unsafe to call, and
|
||||||
/// documentation can be found directly on the method.
|
/// documentation can be found directly on the method.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::sync::{StaticMutex, MUTEX_INIT};
|
/// use std::sync::{StaticMutex, MUTEX_INIT};
|
||||||
|
|
|
@ -24,7 +24,7 @@ use sync::{StaticMutex, MUTEX_INIT};
|
||||||
/// functionality. This type can only be constructed with the `ONCE_INIT`
|
/// functionality. This type can only be constructed with the `ONCE_INIT`
|
||||||
/// value.
|
/// value.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::sync::{Once, ONCE_INIT};
|
/// use std::sync::{Once, ONCE_INIT};
|
||||||
|
|
|
@ -74,7 +74,7 @@ unsafe impl<T: Send + Sync> Sync for RwLock<T> {}
|
||||||
/// automatic global access as well as lazy initialization. The internal
|
/// automatic global access as well as lazy initialization. The internal
|
||||||
/// resources of this RwLock, however, must be manually deallocated.
|
/// resources of this RwLock, however, must be manually deallocated.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::{StaticRwLock, RW_LOCK_INIT};
|
/// use std::sync::{StaticRwLock, RW_LOCK_INIT};
|
||||||
|
|
|
@ -22,7 +22,7 @@ use sync::{Mutex, Condvar};
|
||||||
/// until the counter is positive, and each release will increment the counter
|
/// until the counter is positive, and each release will increment the counter
|
||||||
/// and unblock any threads if necessary.
|
/// and unblock any threads if necessary.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::sync::Semaphore;
|
/// use std::sync::Semaphore;
|
||||||
|
|
|
@ -58,7 +58,7 @@ impl<'a> Drop for Sentinel<'a> {
|
||||||
/// Spawns `n` worker threads and replenishes the pool if any worker threads
|
/// Spawns `n` worker threads and replenishes the pool if any worker threads
|
||||||
/// panic.
|
/// panic.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use std::sync::TaskPool;
|
/// use std::sync::TaskPool;
|
||||||
|
|
|
@ -28,7 +28,7 @@
|
||||||
//! more useful in practice than this OS-based version which likely requires
|
//! more useful in practice than this OS-based version which likely requires
|
||||||
//! unsafe code to interoperate with.
|
//! unsafe code to interoperate with.
|
||||||
//!
|
//!
|
||||||
//! # Example
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! Using a dynamically allocated TLS key. Note that this key can be shared
|
//! Using a dynamically allocated TLS key. Note that this key can be shared
|
||||||
//! among many threads via an `Arc`.
|
//! among many threads via an `Arc`.
|
||||||
|
@ -73,7 +73,7 @@ use sys::thread_local as imp;
|
||||||
/// time. The key is also deallocated when the Rust runtime exits or `destroy`
|
/// time. The key is also deallocated when the Rust runtime exits or `destroy`
|
||||||
/// is called, whichever comes first.
|
/// is called, whichever comes first.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```ignore
|
/// ```ignore
|
||||||
/// use tls::os::{StaticKey, INIT};
|
/// use tls::os::{StaticKey, INIT};
|
||||||
|
@ -110,7 +110,7 @@ pub struct StaticKeyInner {
|
||||||
/// Implementations will likely, however, contain unsafe code as this type only
|
/// Implementations will likely, however, contain unsafe code as this type only
|
||||||
/// operates on `*mut u8`, an unsafe pointer.
|
/// operates on `*mut u8`, an unsafe pointer.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust,ignore
|
/// ```rust,ignore
|
||||||
/// use tls::os::Key;
|
/// use tls::os::Key;
|
||||||
|
|
|
@ -300,7 +300,7 @@ pub mod compat {
|
||||||
|
|
||||||
/// Macro for creating a compatibility fallback for a Windows function
|
/// Macro for creating a compatibility fallback for a Windows function
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
/// ```
|
/// ```
|
||||||
/// compat_fn!(adll32::SomeFunctionW(_arg: LPCWSTR) {
|
/// compat_fn!(adll32::SomeFunctionW(_arg: LPCWSTR) {
|
||||||
/// // Fallback implementation
|
/// // Fallback implementation
|
||||||
|
|
|
@ -68,7 +68,7 @@ pub mod __impl {
|
||||||
/// within a thread, and values support destructors which will be run when a
|
/// within a thread, and values support destructors which will be run when a
|
||||||
/// thread exits.
|
/// thread exits.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// use std::cell::RefCell;
|
/// use std::cell::RefCell;
|
||||||
|
|
|
@ -21,7 +21,7 @@
|
||||||
//! period of time and it is not required to relinquish ownership of the
|
//! period of time and it is not required to relinquish ownership of the
|
||||||
//! contents.
|
//! contents.
|
||||||
//!
|
//!
|
||||||
//! # Example
|
//! # Examples
|
||||||
//!
|
//!
|
||||||
//! ```
|
//! ```
|
||||||
//! scoped_thread_local!(static FOO: u32);
|
//! scoped_thread_local!(static FOO: u32);
|
||||||
|
@ -139,7 +139,7 @@ impl<T> Key<T> {
|
||||||
/// Upon return, this function will restore the previous value, if any
|
/// Upon return, this function will restore the previous value, if any
|
||||||
/// was available.
|
/// was available.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```
|
/// ```
|
||||||
/// scoped_thread_local!(static FOO: u32);
|
/// scoped_thread_local!(static FOO: u32);
|
||||||
|
@ -191,7 +191,7 @@ impl<T> Key<T> {
|
||||||
///
|
///
|
||||||
/// This function will panic if `set` has not previously been called.
|
/// This function will panic if `set` has not previously been called.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// scoped_thread_local!(static FOO: u32);
|
/// scoped_thread_local!(static FOO: u32);
|
||||||
|
|
|
@ -5372,7 +5372,7 @@ impl<'a> Parser<'a> {
|
||||||
|
|
||||||
/// Parse extern crate links
|
/// Parse extern crate links
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// extern crate url;
|
/// extern crate url;
|
||||||
/// extern crate foo = "bar"; //deprecated
|
/// extern crate foo = "bar"; //deprecated
|
||||||
|
|
|
@ -479,7 +479,7 @@ impl<'a> Iterator for Utf16Items<'a> {
|
||||||
/// Create an iterator over the UTF-16 encoded codepoints in `v`,
|
/// Create an iterator over the UTF-16 encoded codepoints in `v`,
|
||||||
/// returning invalid surrogates as `LoneSurrogate`s.
|
/// returning invalid surrogates as `LoneSurrogate`s.
|
||||||
///
|
///
|
||||||
/// # Example
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// ```rust
|
/// ```rust
|
||||||
/// use unicode::str::Utf16Item::{ScalarValue, LoneSurrogate};
|
/// use unicode::str::Utf16Item::{ScalarValue, LoneSurrogate};
|
||||||
|
|
Loading…
Reference in New Issue