std::boxed::Box - Rust
Description: API documentation for the Rust `Box` struct in crate `std`.
Keywords: rust, rustlang, rust-lang, Box

# Struct std::boxed::Box 1.0.0 [−] [src]

    #[lang = "owned_box"]
    pub struct Box<T>(_)
     where
        T: ?Sized;

A pointer type for heap allocation.

See the module-level documentation for more.

## Methods

### `impl<T> Box<T>`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`pub fn new(x: T) -> Box<T>`
[src]

Allocates memory on the heap and then places `x` into it.

This doesn't actually allocate if `T` is zero-sized.

# Examples

    let five = Box::new(5);Run

### `impl<T> Box<T> where
T: ?Sized,`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`pub unsafe fn from_raw(raw: *mut T) -> Box<T>`
1.4.0
[src]

Constructs a box from a raw pointer.

After calling this function, the raw pointer is owned by the resulting `Box`. Specifically, the `Box` destructor will call the destructor of `T` and free the allocated memory. Since the way `Box` allocates and releases memory is unspecified, the only valid pointer to pass to this function is the one taken from another `Box` via the `Box::into_raw` function.

This function is unsafe because improper use may lead to memory problems. For example, a double-free may occur if the function is called twice on the same raw pointer.

# Examples

    let x = Box::new(5);
    let ptr = Box::into_raw(x);
    let x = unsafe { Box::from_raw(ptr) };Run

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`pub unsafe fn from_unique(u: Unique<T>) -> Box<T>`
[src]

🔬 This is a nightly-only experimental API. (`unique` #27730)

needs an RFC to flesh out design

Constructs a `Box` from a `Unique<T>` pointer.

After calling this function, the memory is owned by a `Box` and `T` can then be destroyed and released upon drop.

# Safety

A `Unique<T>` can be safely created via `Unique::new` and thus doesn't necessarily own the data pointed to nor is the data guaranteed to live as long as the pointer.

# Examples

    #![feature(unique)]

    fn main() {
        let x = Box::new(5);
        let ptr = Box::into_unique(x);
        let x = unsafe { Box::from_unique(ptr) };
    }Run

#### `pub fn into_raw(b: Box<T>) -> *mut T`
1.4.0
[src]

Consumes the `Box`, returning the wrapped raw pointer.

After calling this function, the caller is responsible for the memory previously managed by the `Box`. In particular, the caller should properly destroy `T` and release the memory. The proper way to do so is to convert the raw pointer back into a `Box` with the `Box::from_raw` function.

Note: this is an associated function, which means that you have to call it as `Box::into_raw(b)` instead of `b.into_raw()`. This is so that there is no conflict with a method on the inner type.

# Examples

    let x = Box::new(5);
    let ptr = Box::into_raw(x);Run

#### `pub fn into_unique(b: Box<T>) -> Unique<T>`
[src]

🔬 This is a nightly-only experimental API. (`unique` #27730)

needs an RFC to flesh out design

Consumes the `Box`, returning the wrapped pointer as `Unique<T>`.

After calling this function, the caller is responsible for the memory previously managed by the `Box`. In particular, the caller should properly destroy `T` and release the memory. The proper way to do so is to either convert the `Unique<T>` pointer:

- Into a `Box` with the `Box::from_unique` function.

- Into a raw pointer and back into a `Box` with the `Box::from_raw` function.

Note: this is an associated function, which means that you have to call it as `Box::into_unique(b)` instead of `b.into_unique()`. This is so that there is no conflict with a method on the inner type.

# Examples

    #![feature(unique)]

    fn main() {
        let x = Box::new(5);
        let ptr = Box::into_unique(x);
    }Run

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`pub fn leak<'a>(b: Box<T>) -> &'a mut T where
T: 'a,`
[src]

🔬 This is a nightly-only experimental API. (`box_leak` #46179)

needs an FCP to stabilize

Consumes and leaks the `Box`, returning a mutable reference, `&'a mut T`. Here, the lifetime `'a` may be chosen to be `'static`.

This function is mainly useful for data that lives for the remainder of the program's life. Dropping the returned reference will cause a memory leak. If this is not acceptable, the reference should first be wrapped with the `Box::from_raw` function producing a `Box`. This `Box` can then be dropped which will properly destroy `T` and release the allocated memory.

Note: this is an associated function, which means that you have to call it as `Box::leak(b)` instead of `b.leak()`. This is so that there is no conflict with a method on the inner type.

# Examples

Simple usage:

    #![feature(box_leak)]

    fn main() {
        let x = Box::new(41);
        let static_ref: &'static mut usize = Box::leak(x);
        *static_ref += 1;
        assert_eq!(*static_ref, 42);
    }Run

Unsized data:

    #![feature(box_leak)]

    fn main() {
        let x = vec![1, 2, 3].into_boxed_slice();
        let static_ref = Box::leak(x);
        static_ref[0] = 4;
        assert_eq!(*static_ref, [4, 2, 3]);
    }Run

### `impl Box<Any + 'static>`
[src]

#### `pub fn downcast<T>(self) -> Result<Box<T>, Box<Any + 'static>> where
T: Any,`
[src]

Attempt to downcast the box to a concrete type.

# Examples

    use std::any::Any;

    fn print_if_string(value: Box<Any>) {
        if let Ok(string) = value.downcast::<String>() {
            println!("String ({}): {}", string.len(), string);
        }
    }

    fn main() {
        let my_string = "Hello World".to_string();
        print_if_string(Box::new(my_string));
        print_if_string(Box::new(0i8));
    }Run

### `impl Box<Any + 'static + Send>`
[src]

#### `pub fn downcast<T>(self) -> Result<Box<T>, Box<Any + 'static + Send>> where
T: Any,`
[src]

Attempt to downcast the box to a concrete type.

# Examples

    use std::any::Any;

    fn print_if_string(value: Box<Any + Send>) {
        if let Ok(string) = value.downcast::<String>() {
            println!("String ({}): {}", string.len(), string);
        }
    }

    fn main() {
        let my_string = "Hello World".to_string();
        print_if_string(Box::new(my_string));
        print_if_string(Box::new(0i8));
    }Run

## Trait Implementations

### `impl<I> DoubleEndedIterator for Box<I> where
I: DoubleEndedIterator + ?Sized,`
[src]

#### `fn next_back(&mut self) -> Option<<I as Iterator>::Item>`
[src]

Removes and returns an element from the end of the iterator. Read more

#### `fn try_rfold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,`
[src]

🔬 This is a nightly-only experimental API. (`iterator_try_fold` #45594)

This is the reverse version of [`try_fold()`]: it takes elements starting from the back of the iterator. Read more

#### `fn rfold<B, F>(self, accum: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,`
[src]

🔬 This is a nightly-only experimental API. (`iter_rfold` #44705)

An iterator method that reduces the iterator's elements to a single, final value, starting from the back. Read more

#### `fn rfind<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,`
[src]

🔬 This is a nightly-only experimental API. (`iter_rfind` #39480)

Searches for an element of an iterator from the right that satisfies a predicate. Read more

### `impl From<String> for Box<str>`
1.20.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(s: String) -> Box<str>`
[src]

Performs the conversion.

### `impl From<Box<str>> for Box<[u8]>`
1.19.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(s: Box<str>) -> Box<[u8]>`
[src]

Performs the conversion.

### `impl<T> From<Box<T>> for Rc<T> where
T: ?Sized,`
1.21.0
[src]

#### `fn from(v: Box<T>) -> Rc<T>`
[src]

Performs the conversion.

### `impl<T> From<Box<[T]>> for Vec<T>`
1.18.0
[src]

####
ⓘImportant traits for Vec<u8>

### Important traits for Vec<u8>

`impl Write for Vec<u8>`
`fn from(s: Box<[T]>) -> Vec<T>`
[src]

Performs the conversion.

### `impl From<Box<str>> for String`
1.18.0
[src]

#### `fn from(s: Box<str>) -> String`
[src]

Performs the conversion.

### `impl<'a, T> From<&'a [T]> for Box<[T]> where
T: Copy,`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(slice: &'a [T]) -> Box<[T]>`
[src]

Performs the conversion.

### `impl<T> From<Box<T>> for Arc<T> where
T: ?Sized,`
1.21.0
[src]

#### `fn from(v: Box<T>) -> Arc<T>`
[src]

Performs the conversion.

### `impl<'a> From<&'a str> for Box<str>`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(s: &'a str) -> Box<str>`
[src]

Performs the conversion.

### `impl<T> From<T> for Box<T>`
1.6.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(t: T) -> Box<T>`
[src]

Performs the conversion.

### `impl<T> From<Vec<T>> for Box<[T]>`
1.20.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(v: Vec<T>) -> Box<[T]>`
[src]

Performs the conversion.

### `impl<T, U> CoerceUnsized<Box<U>> for Box<T> where
T: Unsize<U> + ?Sized,
U: ?Sized,`
[src]

### `impl<T> Hasher for Box<T> where
T: Hasher + ?Sized,`
1.22.0
[src]

#### `fn finish(&self) -> u64`
[src]

Returns the hash value for the values written so far. Read more

#### `fn write(&mut self, bytes: &[u8])`
[src]

Writes some data into this `Hasher`. Read more

#### `fn write_u8(&mut self, i: u8)`
[src]

Writes a single `u8` into this hasher.

#### `fn write_u16(&mut self, i: u16)`
[src]

Writes a single `u16` into this hasher.

#### `fn write_u32(&mut self, i: u32)`
[src]

Writes a single `u32` into this hasher.

#### `fn write_u64(&mut self, i: u64)`
[src]

Writes a single `u64` into this hasher.

#### `fn write_u128(&mut self, i: u128)`
[src]

🔬 This is a nightly-only experimental API. (`i128` #35118)

Writes a single `u128` into this hasher.

#### `fn write_usize(&mut self, i: usize)`
[src]

Writes a single `usize` into this hasher.

#### `fn write_i8(&mut self, i: i8)`
[src]

Writes a single `i8` into this hasher.

#### `fn write_i16(&mut self, i: i16)`
[src]

Writes a single `i16` into this hasher.

#### `fn write_i32(&mut self, i: i32)`
[src]

Writes a single `i32` into this hasher.

#### `fn write_i64(&mut self, i: i64)`
[src]

Writes a single `i64` into this hasher.

#### `fn write_i128(&mut self, i: i128)`
[src]

🔬 This is a nightly-only experimental API. (`i128` #35118)

Writes a single `i128` into this hasher.

#### `fn write_isize(&mut self, i: isize)`
[src]

Writes a single `isize` into this hasher.

### `impl<T> PartialOrd<Box<T>> for Box<T> where
T: PartialOrd<T> + ?Sized,`
[src]

#### `fn partial_cmp(&self, other: &Box<T>) -> Option<Ordering>`
[src]

This method returns an ordering between `self` and `other` values if one exists. Read more

#### `fn lt(&self, other: &Box<T>) -> bool`
[src]

This method tests less than (for `self` and `other`) and is used by the `<` operator. Read more

#### `fn le(&self, other: &Box<T>) -> bool`
[src]

This method tests less than or equal to (for `self` and `other`) and is used by the `<=` operator. Read more

#### `fn ge(&self, other: &Box<T>) -> bool`
[src]

This method tests greater than or equal to (for `self` and `other`) and is used by the `>=` operator. Read more

#### `fn gt(&self, other: &Box<T>) -> bool`
[src]

This method tests greater than (for `self` and `other`) and is used by the `>` operator. Read more

### `impl<T> Debug for Box<T> where
T: Debug + ?Sized,`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`
[src]

Formats the value using the given formatter. Read more

### `impl<T> PartialEq<Box<T>> for Box<T> where
T: PartialEq<T> + ?Sized,`
[src]

#### `fn eq(&self, other: &Box<T>) -> bool`
[src]

This method tests for `self` and `other` values to be equal, and is used by `==`. Read more

#### `fn ne(&self, other: &Box<T>) -> bool`
[src]

This method tests for `!=`.

### `impl<T> Drop for Box<T> where
T: ?Sized,`
[src]

#### `fn drop(&mut self)`
[src]

Executes the destructor for this type. Read more

### `impl<T> Default for Box<[T]>`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn default() -> Box<[T]>`
[src]

Returns the "default value" for a type. Read more

### `impl<T> Default for Box<T> where
T: Default,`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn default() -> Box<T>`
[src]

Creates a `Box<T>`, with the `Default` value for T.

### `impl Default for Box<str>`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn default() -> Box<str>`
[src]

Returns the "default value" for a type. Read more

### `impl<T> Hash for Box<T> where
T: Hash + ?Sized,`
[src]

#### `fn hash<H>(&self, state: &mut H) where
H: Hasher,`
[src]

Feeds this value into the given [`Hasher`]. Read more

#### `fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,`
1.3.0
[src]

Feeds a slice of this type into the given [`Hasher`]. Read more

### `impl<T> Borrow<T> for Box<T> where
T: ?Sized,`
1.1.0
[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn borrow(&self) -> &T`
[src]

Immutably borrows from an owned value. Read more

### `impl<I> FusedIterator for Box<I> where
I: FusedIterator + ?Sized,`
[src]

### `impl<T> DerefMut for Box<T> where
T: ?Sized,`
[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn deref_mut(&mut self) -> &mut T`
[src]

Mutably dereferences the value.

### `impl<T> Boxed for Box<T>`
[src]

#### `type Data = T`

🔬 This is a nightly-only experimental API. (`placement_new_protocol` #27779)

The kind of data that is stored in this kind of box.

#### `type Place = IntermediateBox<T>`

🔬 This is a nightly-only experimental API. (`placement_new_protocol` #27779)

The place that will negotiate the storage of the data.

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`unsafe fn finalize(b: IntermediateBox<T>) -> Box<T>`
[src]

🔬 This is a nightly-only experimental API. (`placement_new_protocol` #27779)

Converts filled place into final owning value, shifting deallocation/cleanup responsibilities (if any remain), over to returned instance of `Self` and forgetting `filled`. Read more

### `impl<T> Pointer for Box<T> where
T: ?Sized,`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`
[src]

Formats the value using the given formatter.

### `impl<I> ExactSizeIterator for Box<I> where
I: ExactSizeIterator + ?Sized,`
[src]

#### `fn len(&self) -> usize`
[src]

Returns the exact number of times the iterator will iterate. Read more

#### `fn is_empty(&self) -> bool`
[src]

🔬 This is a nightly-only experimental API. (`exact_size_is_empty` #35428)

Returns whether the iterator is empty. Read more

### `impl<T> Generator for Box<T> where
T: Generator + ?Sized,`
[src]

#### `type Yield = <T as Generator>::Yield`

🔬 This is a nightly-only experimental API. (`generator_trait` #43122)

The type of value this generator yields. Read more

#### `type Return = <T as Generator>::Return`

🔬 This is a nightly-only experimental API. (`generator_trait` #43122)

The type of value this generator returns. Read more

#### `fn resume(
&mut self
) -> GeneratorState<<Box<T> as Generator>::Yield, <Box<T> as Generator>::Return>`
[src]

🔬 This is a nightly-only experimental API. (`generator_trait` #43122)

Resumes the execution of this generator. Read more

### `impl<I> Iterator for Box<I> where
I: Iterator + ?Sized,`
[src]

#### `type Item = <I as Iterator>::Item`

The type of the elements being iterated over.

#### `fn next(&mut self) -> Option<<I as Iterator>::Item>`
[src]

Advances the iterator and returns the next value. Read more

#### `fn size_hint(&self) -> (usize, Option<usize>)`
[src]

Returns the bounds on the remaining length of the iterator. Read more

#### `fn nth(&mut self, n: usize) -> Option<<I as Iterator>::Item>`
[src]

Returns the `n`th element of the iterator. Read more

#### `fn count(self) -> usize`
[src]

Consumes the iterator, counting the number of iterations and returning it. Read more

#### `fn last(self) -> Option<Self::Item>`
[src]

Consumes the iterator, returning the last element. Read more

####
ⓘImportant traits for StepBy<I>

### Important traits for StepBy<I>

`impl<I> Iterator for StepBy<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn step_by(self, step: usize) -> StepBy<Self>`
[src]

🔬 This is a nightly-only experimental API. (`iterator_step_by` #27741)

unstable replacement of Range::step_by

Creates an iterator starting at the same point, but stepping by the given amount at each iteration. Read more

####
ⓘImportant traits for Chain<A, B>

### Important traits for Chain<A, B>

`impl<A, B> Iterator for Chain<A, B> where
A: Iterator,
B: Iterator<Item = <A as Iterator>::Item>, type Item = <A as Iterator>::Item;`
`fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator<Item = Self::Item>,`
[src]

Takes two iterators and creates a new iterator over both in sequence. Read more

####
ⓘImportant traits for Zip<A, B>

### Important traits for Zip<A, B>

`impl<A, B> Iterator for Zip<A, B> where
A: Iterator,
B: Iterator, type Item = (<A as Iterator>::Item, <B as Iterator>::Item);`
`fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
U: IntoIterator,`
[src]

'Zips up' two iterators into a single iterator of pairs. Read more

####
ⓘImportant traits for Map<I, F>

### Important traits for Map<I, F>

`impl<B, I, F> Iterator for Map<I, F> where
F: FnMut(<I as Iterator>::Item) -> B,
I: Iterator, type Item = B;`
`fn map<B, F>(self, f: F) -> Map<Self, F> where
F: FnMut(Self::Item) -> B,`
[src]

Takes a closure and creates an iterator which calls that closure on each element. Read more

#### `fn for_each<F>(self, f: F) where
F: FnMut(Self::Item) -> (),`
1.21.0
[src]

Calls a closure on each element of an iterator. Read more

####
ⓘImportant traits for Filter<I, P>

### Important traits for Filter<I, P>

`impl<I, P> Iterator for Filter<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn filter<P>(self, predicate: P) -> Filter<Self, P> where
P: FnMut(&Self::Item) -> bool,`
[src]

Creates an iterator which uses a closure to determine if an element should be yielded. Read more

####
ⓘImportant traits for FilterMap<I, F>

### Important traits for FilterMap<I, F>

`impl<B, I, F> Iterator for FilterMap<I, F> where
F: FnMut(<I as Iterator>::Item) -> Option<B>,
I: Iterator, type Item = B;`
`fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
F: FnMut(Self::Item) -> Option<B>,`
[src]

Creates an iterator that both filters and maps. Read more

####
ⓘImportant traits for Enumerate<I>

### Important traits for Enumerate<I>

`impl<I> Iterator for Enumerate<I> where
I: Iterator, type Item = (usize, <I as Iterator>::Item);`
`fn enumerate(self) -> Enumerate<Self>`
[src]

Creates an iterator which gives the current iteration count as well as the next value. Read more

####
ⓘImportant traits for Peekable<I>

### Important traits for Peekable<I>

`impl<I> Iterator for Peekable<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn peekable(self) -> Peekable<Self>`
[src]

Creates an iterator which can use `peek` to look at the next element of the iterator without consuming it. Read more

####
ⓘImportant traits for SkipWhile<I, P>

### Important traits for SkipWhile<I, P>

`impl<I, P> Iterator for SkipWhile<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,`
[src]

Creates an iterator that [`skip`]s elements based on a predicate. Read more

####
ⓘImportant traits for TakeWhile<I, P>

### Important traits for TakeWhile<I, P>

`impl<I, P> Iterator for TakeWhile<I, P> where
I: Iterator,
P: FnMut(&<I as Iterator>::Item) -> bool, type Item = <I as Iterator>::Item;`
`fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
P: FnMut(&Self::Item) -> bool,`
[src]

Creates an iterator that yields elements based on a predicate. Read more

####
ⓘImportant traits for Skip<I>

### Important traits for Skip<I>

`impl<I> Iterator for Skip<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn skip(self, n: usize) -> Skip<Self>`
[src]

Creates an iterator that skips the first `n` elements. Read more

####
ⓘImportant traits for Take<I>

### Important traits for Take<I>

`impl<I> Iterator for Take<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn take(self, n: usize) -> Take<Self>`
[src]

Creates an iterator that yields its first `n` elements. Read more

####
ⓘImportant traits for Scan<I, St, F>

### Important traits for Scan<I, St, F>

`impl<B, I, St, F> Iterator for Scan<I, St, F> where
F: FnMut(&mut St, <I as Iterator>::Item) -> Option<B>,
I: Iterator, type Item = B;`
`fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
F: FnMut(&mut St, Self::Item) -> Option<B>,`
[src]

An iterator adaptor similar to [`fold`] that holds internal state and produces a new iterator. Read more

####
ⓘImportant traits for FlatMap<I, U, F>

### Important traits for FlatMap<I, U, F>

`impl<I, U, F> Iterator for FlatMap<I, U, F> where
F: FnMut(<I as Iterator>::Item) -> U,
I: Iterator,
U: IntoIterator, type Item = <U as IntoIterator>::Item;`
`fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
F: FnMut(Self::Item) -> U,
U: IntoIterator,`
[src]

Creates an iterator that works like map, but flattens nested structure. Read more

####
ⓘImportant traits for Fuse<I>

### Important traits for Fuse<I>

`impl<I> Iterator for Fuse<I> where
I: FusedIterator, impl<I> Iterator for Fuse<I> where
I: Iterator, type Item = <I as Iterator>::Item;`
`fn fuse(self) -> Fuse<Self>`
[src]

Creates an iterator which ends after the first [`None`]. Read more

####
ⓘImportant traits for Inspect<I, F>

### Important traits for Inspect<I, F>

`impl<I, F> Iterator for Inspect<I, F> where
F: FnMut(&<I as Iterator>::Item) -> (),
I: Iterator, type Item = <I as Iterator>::Item;`
`fn inspect<F>(self, f: F) -> Inspect<Self, F> where
F: FnMut(&Self::Item) -> (),`
[src]

Do something with each element of an iterator, passing the value on. Read more

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn by_ref(&mut self) -> &mut Self`
[src]

Borrows an iterator, rather than consuming it. Read more

#### `fn collect<B>(self) -> B where
B: FromIterator<Self::Item>,`
[src]

Transforms an iterator into a collection. Read more

#### `fn partition<B, F>(self, f: F) -> (B, B) where
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,`
[src]

Consumes an iterator, creating two collections from it. Read more

#### `fn try_fold<B, F, R>(&mut self, init: B, f: F) -> R where
F: FnMut(B, Self::Item) -> R,
R: Try<Ok = B>,`
[src]

🔬 This is a nightly-only experimental API. (`iterator_try_fold` #45594)

An iterator method that applies a function as long as it returns successfully, producing a single, final value. Read more

#### `fn fold<B, F>(self, init: B, f: F) -> B where
F: FnMut(B, Self::Item) -> B,`
[src]

An iterator method that applies a function, producing a single, final value. Read more

#### `fn all<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,`
[src]

Tests if every element of the iterator matches a predicate. Read more

#### `fn any<F>(&mut self, f: F) -> bool where
F: FnMut(Self::Item) -> bool,`
[src]

Tests if any element of the iterator matches a predicate. Read more

#### `fn find<P>(&mut self, predicate: P) -> Option<Self::Item> where
P: FnMut(&Self::Item) -> bool,`
[src]

Searches for an element of an iterator that satisfies a predicate. Read more

#### `fn position<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,`
[src]

Searches for an element in an iterator, returning its index. Read more

#### `fn rposition<P>(&mut self, predicate: P) -> Option<usize> where
P: FnMut(Self::Item) -> bool,
Self: ExactSizeIterator + DoubleEndedIterator,`
[src]

Searches for an element in an iterator from the right, returning its index. Read more

#### `fn max(self) -> Option<Self::Item> where
Self::Item: Ord,`
[src]

Returns the maximum element of an iterator. Read more

#### `fn min(self) -> Option<Self::Item> where
Self::Item: Ord,`
[src]

Returns the minimum element of an iterator. Read more

#### `fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,`
1.6.0
[src]

Returns the element that gives the maximum value from the specified function. Read more

#### `fn max_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,`
1.15.0
[src]

Returns the element that gives the maximum value with respect to the specified comparison function. Read more

#### `fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where
B: Ord,
F: FnMut(&Self::Item) -> B,`
1.6.0
[src]

Returns the element that gives the minimum value from the specified function. Read more

#### `fn min_by<F>(self, compare: F) -> Option<Self::Item> where
F: FnMut(&Self::Item, &Self::Item) -> Ordering,`
1.15.0
[src]

Returns the element that gives the minimum value with respect to the specified comparison function. Read more

####
ⓘImportant traits for Rev<I>

### Important traits for Rev<I>

`impl<I> Iterator for Rev<I> where
I: DoubleEndedIterator, type Item = <I as Iterator>::Item;`
`fn rev(self) -> Rev<Self> where
Self: DoubleEndedIterator,`
[src]

Reverses an iterator's direction. Read more

#### `fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB) where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Iterator<Item = (A, B)>,`
[src]

Converts an iterator of pairs into a pair of containers. Read more

####
ⓘImportant traits for Cloned<I>

### Important traits for Cloned<I>

`impl<'a, I, T> Iterator for Cloned<I> where
I: Iterator<Item = &'a T>,
T: 'a + Clone, type Item = T;`
`fn cloned<'a, T>(self) -> Cloned<Self> where
Self: Iterator<Item = &'a T>,
T: 'a + Clone,`
[src]

Creates an iterator which [`clone`]s all of its elements. Read more

####
ⓘImportant traits for Cycle<I>

### Important traits for Cycle<I>

`impl<I> Iterator for Cycle<I> where
I: Clone + Iterator, type Item = <I as Iterator>::Item;`
`fn cycle(self) -> Cycle<Self> where
Self: Clone,`
[src]

Repeats an iterator endlessly. Read more

#### `fn sum<S>(self) -> S where
S: Sum<Self::Item>,`
1.11.0
[src]

Sums the elements of an iterator. Read more

#### `fn product<P>(self) -> P where
P: Product<Self::Item>,`
1.11.0
[src]

Iterates over the entire iterator, multiplying all the elements Read more

#### `fn cmp<I>(self, other: I) -> Ordering where
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,`
1.5.0
[src]

Lexicographically compares the elements of this `Iterator` with those of another. Read more

#### `fn partial_cmp<I>(self, other: I) -> Option<Ordering> where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Lexicographically compares the elements of this `Iterator` with those of another. Read more

#### `fn eq<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are equal to those of another. Read more

#### `fn ne<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialEq<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are unequal to those of another. Read more

#### `fn lt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically less than those of another. Read more

#### `fn le<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically less or equal to those of another. Read more

#### `fn gt<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically greater than those of another. Read more

#### `fn ge<I>(self, other: I) -> bool where
I: IntoIterator,
Self::Item: PartialOrd<<I as IntoIterator>::Item>,`
1.5.0
[src]

Determines if the elements of this `Iterator` are lexicographically greater than or equal to those of another. Read more

### `impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output = R> + 'a>`
[src]

#### `type Output = R`

The returned type after the call operator is used.

#### `extern "rust-call" fn call_once(self, args: A) -> R`
[src]

🔬 This is a nightly-only experimental API. (`fn_traits` #29625)

Performs the call operation.

### `impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output = R> + 'a + Send>`
[src]

#### `type Output = R`

The returned type after the call operator is used.

#### `extern "rust-call" fn call_once(self, args: A) -> R`
[src]

🔬 This is a nightly-only experimental API. (`fn_traits` #29625)

Performs the call operation.

### `impl<T> AsMut<T> for Box<T> where
T: ?Sized,`
1.5.0
[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn as_mut(&mut self) -> &mut T`
[src]

Performs the conversion.

### `impl<T> AsRef<T> for Box<T> where
T: ?Sized,`
1.5.0
[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn as_ref(&self) -> &T`
[src]

Performs the conversion.

### `impl<T> Deref for Box<T> where
T: ?Sized,`
[src]

#### `type Target = T`

The resulting type after dereferencing.

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn deref(&self) -> &T`
[src]

Dereferences the value.

### `impl Clone for Box<str>`
1.3.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn clone(&self) -> Box<str>`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
[src]

Performs copy-assignment from `source`. Read more

### `impl<T> Clone for Box<T> where
T: Clone,`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn clone(&self) -> Box<T>`
[src]

Returns a new box with a `clone()` of this box's contents.

# Examples

    let x = Box::new(5);
    let y = x.clone();Run

#### `fn clone_from(&mut self, source: &Box<T>)`
[src]

Copies `source`'s contents into `self` without creating a new allocation.

# Examples

    let x = Box::new(5);
    let mut y = Box::new(10);

    y.clone_from(&x);

    assert_eq!(*y, 5);Run

### `impl<T> Clone for Box<[T]> where
T: Clone,`
1.3.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn clone(&self) -> Box<[T]>`
[src]

Returns a copy of the value. Read more

#### `fn clone_from(&mut self, source: &Self)`
[src]

Performs copy-assignment from `source`. Read more

### `impl<T> Display for Box<T> where
T: Display + ?Sized,`
[src]

#### `fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`
[src]

Formats the value using the given formatter. Read more

### `impl<T> Eq for Box<T> where
T: Eq + ?Sized,`
[src]

### `impl<T> Ord for Box<T> where
T: Ord + ?Sized,`
[src]

#### `fn cmp(&self, other: &Box<T>) -> Ordering`
[src]

This method returns an `Ordering` between `self` and `other`. Read more

#### `fn max(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the maximum of two values. Read more

#### `fn min(self, other: Self) -> Self`
1.21.0
[src]

Compares and returns the minimum of two values. Read more

### `impl<T> BorrowMut<T> for Box<T> where
T: ?Sized,`
1.1.0
[src]

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn borrow_mut(&mut self) -> &mut T`
[src]

Mutably borrows from an owned value. Read more

### `impl<'a, E: Error + 'a> From<E> for Box<Error + 'a>`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(err: E) -> Box<Error + 'a>`
[src]

Performs the conversion.

### `impl<'a, E: Error + Send + Sync + 'a> From<E> for Box<Error + Send + Sync + 'a>`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(err: E) -> Box<Error + Send + Sync + 'a>`
[src]

Performs the conversion.

### `impl From<String> for Box<Error + Send + Sync>`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(err: String) -> Box<Error + Send + Sync>`
[src]

Performs the conversion.

### `impl From<String> for Box<Error>`
1.6.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(str_err: String) -> Box<Error>`
[src]

Performs the conversion.

### `impl<'a, 'b> From<&'b str> for Box<Error + Send + Sync + 'a>`
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(err: &'b str) -> Box<Error + Send + Sync + 'a>`
[src]

Performs the conversion.

### `impl<'a> From<&'a str> for Box<Error>`
1.6.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(err: &'a str) -> Box<Error>`
[src]

Performs the conversion.

### `impl<'a, 'b> From<Cow<'b, str>> for Box<Error + Send + Sync + 'a>`
1.22.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(err: Cow<'b, str>) -> Box<Error + Send + Sync + 'a>`
[src]

Performs the conversion.

### `impl<'a> From<Cow<'a, str>> for Box<Error>`
1.22.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(err: Cow<'a, str>) -> Box<Error>`
[src]

Performs the conversion.

### `impl<T: Error> Error for Box<T>`
1.8.0
[src]

#### `fn description(&self) -> &str`
[src]

A short description of the error. Read more

#### `fn cause(&self) -> Option<&Error>`
[src]

The lower-level cause of this error, if any. Read more

### `impl<'a> From<&'a CStr> for Box<CStr>`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(s: &'a CStr) -> Box<CStr>`
[src]

Performs the conversion.

### `impl From<Box<CStr>> for CString`
1.18.0
[src]

#### `fn from(s: Box<CStr>) -> CString`
[src]

Performs the conversion.

### `impl From<CString> for Box<CStr>`
1.20.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(s: CString) -> Box<CStr>`
[src]

Performs the conversion.

### `impl Default for Box<CStr>`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn default() -> Box<CStr>`
[src]

Returns the "default value" for a type. Read more

### `impl<'a> From<&'a OsStr> for Box<OsStr>`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(s: &'a OsStr) -> Box<OsStr>`
[src]

Performs the conversion.

### `impl From<Box<OsStr>> for OsString`
1.18.0
[src]

#### `fn from(boxed: Box<OsStr>) -> OsString`
[src]

Performs the conversion.

### `impl From<OsString> for Box<OsStr>`
1.20.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(s: OsString) -> Box<OsStr>`
[src]

Performs the conversion.

### `impl Default for Box<OsStr>`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn default() -> Box<OsStr>`
[src]

Returns the "default value" for a type. Read more

### `impl<R: Read + ?Sized> Read for Box<R>`
[src]

#### `fn read(&mut self, buf: &mut [u8]) -> Result<usize>`
[src]

Pull some bytes from this source into the specified buffer, returning how many bytes were read. Read more

#### `unsafe fn initializer(&self) -> Initializer`
[src]

🔬 This is a nightly-only experimental API. (`read_initializer` #42788)

Determines if this `Read`er can work with buffers of uninitialized memory. Read more

#### `fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>`
[src]

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_to_string(&mut self, buf: &mut String) -> Result<usize>`
[src]

Read all bytes until EOF in this source, placing them into `buf`. Read more

#### `fn read_exact(&mut self, buf: &mut [u8]) -> Result<()>`
[src]

Read the exact number of bytes required to fill `buf`. Read more

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn by_ref(&mut self) -> &mut Self where
Self: Sized,`
[src]

Creates a "by reference" adaptor for this instance of `Read`. Read more

####
ⓘImportant traits for Bytes<R>

### Important traits for Bytes<R>

`impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;`
`fn bytes(self) -> Bytes<Self> where
Self: Sized,`
[src]

Transforms this `Read` instance to an [`Iterator`] over its bytes. Read more

####
ⓘImportant traits for Chars<R>

### Important traits for Chars<R>

`impl<R: Read> Iterator for Chars<R> type Item = Result<char, CharsError>;`
`fn chars(self) -> Chars<Self> where
Self: Sized,`
[src]

🔬 This is a nightly-only experimental API. (`io` #27802)

the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this `Read` instance to an [`Iterator`] over [`char`]s. Read more

####
ⓘImportant traits for Chain<T, U>

### Important traits for Chain<T, U>

`impl<T: Read, U: Read> Read for Chain<T, U>`
`fn chain<R: Read>(self, next: R) -> Chain<Self, R> where
Self: Sized,`
[src]

Creates an adaptor which will chain this stream with another. Read more

####
ⓘImportant traits for Take<T>

### Important traits for Take<T>

`impl<T: Read> Read for Take<T>`
`fn take(self, limit: u64) -> Take<Self> where
Self: Sized,`
[src]

Creates an adaptor which will read at most `limit` bytes from it. Read more

### `impl<W: Write + ?Sized> Write for Box<W>`
[src]

#### `fn write(&mut self, buf: &[u8]) -> Result<usize>`
[src]

Write a buffer into this object, returning how many bytes were written. Read more

#### `fn flush(&mut self) -> Result<()>`
[src]

Flush this output stream, ensuring that all intermediately buffered contents reach their destination. Read more

#### `fn write_all(&mut self, buf: &[u8]) -> Result<()>`
[src]

Attempts to write an entire buffer into this write. Read more

#### `fn write_fmt(&mut self, fmt: Arguments) -> Result<()>`
[src]

Writes a formatted string into this writer, returning any error encountered. Read more

####
ⓘImportant traits for &'a mut I

### Important traits for &'a mut I

`impl<'a, I> Iterator for &'a mut I where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'a, R: Read + ?Sized> Read for &'a mut Rimpl<'a, W: Write + ?Sized> Write for &'a mut W`
`fn by_ref(&mut self) -> &mut Self where
Self: Sized,`
[src]

Creates a "by reference" adaptor for this instance of `Write`. Read more

### `impl<S: Seek + ?Sized> Seek for Box<S>`
[src]

#### `fn seek(&mut self, pos: SeekFrom) -> Result<u64>`
[src]

Seek to an offset, in bytes, in a stream. Read more

### `impl<B: BufRead + ?Sized> BufRead for Box<B>`
[src]

#### `fn fill_buf(&mut self) -> Result<&[u8]>`
[src]

Fills the internal buffer of this object, returning the buffer contents. Read more

#### `fn consume(&mut self, amt: usize)`
[src]

Tells this buffer that `amt` bytes have been consumed from the buffer, so they should no longer be returned in calls to `read`. Read more

#### `fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>`
[src]

Read all bytes into `buf` until the delimiter `byte` or EOF is reached. Read more

#### `fn read_line(&mut self, buf: &mut String) -> Result<usize>`
[src]

Read all bytes until a newline (the 0xA byte) is reached, and append them to the provided buffer. Read more

####
ⓘImportant traits for Split<B>

### Important traits for Split<B>

`impl<B: BufRead> Iterator for Split<B> type Item = Result<Vec<u8>>;`
`fn split(self, byte: u8) -> Split<Self> where
Self: Sized,`
[src]

Returns an iterator over the contents of this reader split on the byte `byte`. Read more

####
ⓘImportant traits for Lines<B>

### Important traits for Lines<B>

`impl<B: BufRead> Iterator for Lines<B> type Item = Result<String>;`
`fn lines(self) -> Lines<Self> where
Self: Sized,`
[src]

Returns an iterator over the lines of this reader. Read more

### `impl<'a> From<&'a Path> for Box<Path>`
1.17.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(path: &'a Path) -> Box<Path>`
[src]

Performs the conversion.

### `impl From<Box<Path>> for PathBuf`
1.18.0
[src]

#### `fn from(boxed: Box<Path>) -> PathBuf`
[src]

Performs the conversion.

### `impl From<PathBuf> for Box<Path>`
1.20.0
[src]

####
ⓘImportant traits for Box<I>

### Important traits for Box<I>

`impl<I> Iterator for Box<I> where
I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>`
`fn from(p: PathBuf) -> Box<Path>`
[src]

Performs the conversion.

# Help

## Keyboard Shortcuts

?
  Show this help dialog
S
  Focus the search field
↑
  Move up in search results
↓
  Move down in search results
↹
  Switch tab
⏎
  Go to active search result
+ / -
  Collapse/expand all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g. `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g. `vec -> usize` or `* -> vec`)