Struct std::boxed::Box

[+] Show type declaration

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

[−] Expand description

A pointer type for heap allocation.

See the module-level documentation for more.

Methods

impl<T> Box<T>

[−]

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>

[−]

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);

impl<T> Box<T> where     T: ?Sized,

[−]

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>

[−]

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) };

pub fn into_raw(b: Box<T>) -> *mut T

[−]

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);

pub fn into_raw_non_null(b: Box<T>) -> NonNull<T>

[−]

🔬 This is a nightly-only experimental API. (box_into_raw_non_null #47336)

Consumes the Box, returning the wrapped pointer as NonNull<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 convert the NonNull<T> pointer 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_raw_non_null(b) instead of b.into_raw_non_null(). This is so that there is no conflict with a method on the inner type.

Examples

#![feature(box_into_raw_non_null)]

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

pub fn into_unique(b: Box<T>) -> Unique<T>

🔬 This is a nightly-only experimental API. (ptr_internals)

use into_raw_non_null instead

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,

[−]

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:

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

Unsized data:

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]);
}

impl Box<Any + 'static>

[−]

pub fn downcast<T>(self) -> Result<Box<T>, Box<Any + 'static>> where     T: Any,

[−]

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));
}

impl Box<Any + 'static + Send>

[−]

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

[−]

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));
}

Trait Implementations

impl<I> Iterator for Box<I> where     I: Iterator + ?Sized,

[+]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

fn next(&mut self) -> Option<<I as Iterator>::Item>

[−]

Advances the iterator and returns the next value.

fn size_hint(&self) -> (usize, Option<usize>)

[−]

Returns the bounds on the remaining length of the iterator.

fn nth(&mut self, n: usize) -> Option<<I as Iterator>::Item>

[−]

Returns the nth element of the iterator.

fn count(self) -> usize

[−]

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

fn last(self) -> Option<Self::Item>

[−]

Consumes the iterator, returning the last element.

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>

[−]

🔬 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.

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>,

[−]

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

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,

[−]

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

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,

[−]

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

fn for_each<F>(self, f: F) where     F: FnMut(Self::Item),

[−]

Calls a closure on each element of an iterator.

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,

[−]

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

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>,

[−]

Creates an iterator that both filters and maps.

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>

[−]

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

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>

[−]

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

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,

[−]

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

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,

[−]

Creates an iterator that yields elements based on a predicate.

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>

[−]

Creates an iterator that skips the first n elements.

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>

[−]

Creates an iterator that yields its first n elements.

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>,

[−]

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

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,

[−]

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

Important traits for Flatten<I>

impl<I, U> Iterator for Flatten<I> where
    I: Iterator,
    U: Iterator,
    <I as Iterator>::Item: IntoIterator,
    <<I as Iterator>::Item as IntoIterator>::IntoIter == U,
    <<I as Iterator>::Item as IntoIterator>::Item == <U as Iterator>::Item,  type Item = <U as Iterator>::Item;

fn flatten(self) -> Flatten<Self> where     Self::Item: IntoIterator,

[−]

🔬 This is a nightly-only experimental API. (iterator_flatten #48213)

Creates an iterator that flattens nested structure.

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>

[−]

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

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),

[−]

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

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

[−]

Borrows an iterator, rather than consuming it.

fn collect<B>(self) -> B where     B: FromIterator<Self::Item>,

[−]

Transforms an iterator into a collection.

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

[−]

Consumes an iterator, creating two collections from it.

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

[−]

🔬 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.

fn try_for_each<F, R>(&mut self, f: F) -> R where     F: FnMut(Self::Item) -> R,     R: Try<Ok = ()>,

[−]

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

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error.

fn fold<B, F>(self, init: B, f: F) -> B where     F: FnMut(B, Self::Item) -> B,

[−]

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

fn all<F>(&mut self, f: F) -> bool where     F: FnMut(Self::Item) -> bool,

[−]

Tests if every element of the iterator matches a predicate.

fn any<F>(&mut self, f: F) -> bool where     F: FnMut(Self::Item) -> bool,

[−]

Tests if any element of the iterator matches a predicate.

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

[−]

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

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

[−]

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

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

[−]

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

fn max(self) -> Option<Self::Item> where     Self::Item: Ord,

[−]

Returns the maximum element of an iterator.

fn min(self) -> Option<Self::Item> where     Self::Item: Ord,

[−]

Returns the minimum element of an iterator.

fn max_by_key<B, F>(self, f: F) -> Option<Self::Item> where     B: Ord,     F: FnMut(&Self::Item) -> B,

[−]

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

fn max_by<F>(self, compare: F) -> Option<Self::Item> where     F: FnMut(&Self::Item, &Self::Item) -> Ordering,

[−]

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

fn min_by_key<B, F>(self, f: F) -> Option<Self::Item> where     B: Ord,     F: FnMut(&Self::Item) -> B,

[−]

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

fn min_by<F>(self, compare: F) -> Option<Self::Item> where     F: FnMut(&Self::Item, &Self::Item) -> Ordering,

[−]

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

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,

[−]

Reverses an iterator's direction.

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

[−]

Converts an iterator of pairs into a pair of containers.

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,

[−]

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

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,

[−]

Repeats an iterator endlessly.

fn sum<S>(self) -> S where     S: Sum<Self::Item>,

[−]

Sums the elements of an iterator.

fn product<P>(self) -> P where     P: Product<Self::Item>,

[−]

Iterates over the entire iterator, multiplying all the elements

fn cmp<I>(self, other: I) -> Ordering where     I: IntoIterator<Item = Self::Item>,     Self::Item: Ord,

[−]

Lexicographically compares the elements of this Iterator with those of another.

fn partial_cmp<I>(self, other: I) -> Option<Ordering> where     I: IntoIterator,     Self::Item: PartialOrd<<I as IntoIterator>::Item>,

[−]

Lexicographically compares the elements of this Iterator with those of another.

fn eq<I>(self, other: I) -> bool where     I: IntoIterator,     Self::Item: PartialEq<<I as IntoIterator>::Item>,

[−]

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

fn ne<I>(self, other: I) -> bool where     I: IntoIterator,     Self::Item: PartialEq<<I as IntoIterator>::Item>,

[−]

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

fn lt<I>(self, other: I) -> bool where     I: IntoIterator,     Self::Item: PartialOrd<<I as IntoIterator>::Item>,

[−]

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

fn le<I>(self, other: I) -> bool where     I: IntoIterator,     Self::Item: PartialOrd<<I as IntoIterator>::Item>,

[−]

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

fn gt<I>(self, other: I) -> bool where     I: IntoIterator,     Self::Item: PartialOrd<<I as IntoIterator>::Item>,

[−]

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

fn ge<I>(self, other: I) -> bool where     I: IntoIterator,     Self::Item: PartialOrd<<I as IntoIterator>::Item>,

[−]

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

impl<T> Pointer for Box<T> where     T: ?Sized,

[+]

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

[−]

Formats the value using the given formatter.

impl<T> Boxed for Box<T>

[+]

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>

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>

[−]

🔬 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.

impl<I> ExactSizeIterator for Box<I> where     I: ExactSizeIterator + ?Sized,

[+]

fn len(&self) -> usize

[−]

Returns the exact number of times the iterator will iterate.

fn is_empty(&self) -> bool

[−]

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

Returns whether the iterator is empty.

impl<T> Borrow<T> for Box<T> where     T: ?Sized,

[+]

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

[−]

Immutably borrows from an owned value.

impl<T> Hasher for Box<T> where     T: Hasher + ?Sized,

[+]

fn finish(&self) -> u64

[−]

Returns the hash value for the values written so far.

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

[−]

Writes some data into this Hasher.

fn write_u8(&mut self, i: u8)

[−]

Writes a single u8 into this hasher.

fn write_u16(&mut self, i: u16)

[−]

Writes a single u16 into this hasher.

fn write_u32(&mut self, i: u32)

[−]

Writes a single u32 into this hasher.

fn write_u64(&mut self, i: u64)

[−]

Writes a single u64 into this hasher.

fn write_u128(&mut self, i: u128)

[−]

Writes a single u128 into this hasher.

fn write_usize(&mut self, i: usize)

[−]

Writes a single usize into this hasher.

fn write_i8(&mut self, i: i8)

[−]

Writes a single i8 into this hasher.

fn write_i16(&mut self, i: i16)

[−]

Writes a single i16 into this hasher.

fn write_i32(&mut self, i: i32)

[−]

Writes a single i32 into this hasher.

fn write_i64(&mut self, i: i64)

[−]

Writes a single i64 into this hasher.

fn write_i128(&mut self, i: i128)

[−]

Writes a single i128 into this hasher.

fn write_isize(&mut self, i: isize)

[−]

Writes a single isize into this hasher.

impl<T> Display for Box<T> where     T: Display + ?Sized,

[+]

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

[−]

Formats the value using the given formatter.

impl<T> Ord for Box<T> where     T: Ord + ?Sized,

[+]

fn cmp(&self, other: &Box<T>) -> Ordering

[−]

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

[−]

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

[−]

Compares and returns the minimum of two values.

impl<I> FusedIterator for Box<I> where     I: FusedIterator + ?Sized,

impl<T> DerefMut for Box<T> where     T: ?Sized,

[+]

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

[−]

Mutably dereferences the value.

impl<T> From<T> for Box<T>

[+]

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>

[−]

Performs the conversion.

impl<T> From<Box<[T]>> for Vec<T>

[+]

Important traits for Vec<u8>

impl Write for Vec<u8>

fn from(s: Box<[T]>) -> Vec<T>

[−]

Performs the conversion.

impl From<Box<str>> for String

[+]

fn from(s: Box<str>) -> String

[−]

Performs the conversion.

impl<T> From<Vec<T>> for Box<[T]>

[+]

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]>

[−]

Performs the conversion.

impl From<String> for Box<str>

[+]

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>

[−]

Performs the conversion.

impl<'a> From<&'a str> for Box<str>

[+]

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>

[−]

Performs the conversion.

impl<T> From<Box<T>> for Rc<T> where     T: ?Sized,

[+]

fn from(v: Box<T>) -> Rc<T>

[−]

Performs the conversion.

impl<T> From<PinBox<T>> for Box<T> where     T: Unpin + ?Sized,

[+]

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(pinned: PinBox<T>) -> Box<T>

[−]

Performs the conversion.

impl<T> From<Box<T>> for PinBox<T> where     T: ?Sized,

[+]

fn from(boxed: Box<T>) -> PinBox<T>

[−]

Performs the conversion.

impl From<Box<str>> for Box<[u8]>

[+]

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]>

[−]

Performs the conversion.

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

[+]

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]>

[−]

Performs the conversion.

impl<T> From<Box<T>> for Arc<T> where     T: ?Sized,

[+]

fn from(v: Box<T>) -> Arc<T>

[−]

Performs the conversion.

impl<T> AsRef<T> for Box<T> where     T: ?Sized,

[+]

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

[−]

Performs the conversion.

impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output = R> + 'a + Send>

[+]

type Output = R

The returned type after the call operator is used.

extern "rust-call" fn call_once(self, args: A) -> R

[−]

🔬 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>

[+]

type Output = R

The returned type after the call operator is used.

extern "rust-call" fn call_once(self, args: A) -> R

[−]

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

Performs the call operation.

impl<T, U> CoerceUnsized<Box<U>> for Box<T> where     T: Unsize<U> + ?Sized,     U: ?Sized,

impl<T> Drop for Box<T> where     T: ?Sized,

[+]

fn drop(&mut self)

[−]

Executes the destructor for this type.

impl<T> Eq for Box<T> where     T: Eq + ?Sized,

impl<T> Hash for Box<T> where     T: Hash + ?Sized,

[+]

fn hash<H>(&self, state: &mut H) where     H: Hasher,

[−]

Feeds this value into the given [Hasher].

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

[−]

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

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

[+]

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]>

[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

[−]

Performs copy-assignment from source.

impl Clone for Box<str>

[+]

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>

[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

[−]

Performs copy-assignment from source.

impl<T> Clone for Box<T> where     T: Clone,

[+]

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>

[−]

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

Examples

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

fn clone_from(&mut self, source: &Box<T>)

[−]

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);

impl<T> AsMut<T> for Box<T> where     T: ?Sized,

[+]

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

[−]

Performs the conversion.

impl<T> Default for Box<T> where     T: Default,

[+]

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>

[−]

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

impl<T> Default for Box<[T]>

[+]

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]>

[−]

Returns the "default value" for a type.

impl Default for Box<str>

[+]

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>

[−]

Returns the "default value" for a type.

impl<T> Deref for Box<T> where     T: ?Sized,

[+]

type Target = T

The resulting type after dereferencing.

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

[−]

Dereferences the value.

impl<T> PartialEq<Box<T>> for Box<T> where     T: PartialEq<T> + ?Sized,

[+]

fn eq(&self, other: &Box<T>) -> bool

[−]

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

fn ne(&self, other: &Box<T>) -> bool

[−]

This method tests for !=.

impl<I> DoubleEndedIterator for Box<I> where     I: DoubleEndedIterator + ?Sized,

[+]

fn next_back(&mut self) -> Option<<I as Iterator>::Item>

[−]

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

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

[−]

🔬 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.

fn rfold<B, F>(self, accum: B, f: F) -> B where     F: FnMut(B, Self::Item) -> B,

[−]

🔬 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.

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

[−]

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

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

impl<T> Generator for Box<T> where     T: Generator + ?Sized,

[+]

type Yield = <T as Generator>::Yield

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

The type of value this generator yields.

type Return = <T as Generator>::Return

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

The type of value this generator returns.

unsafe fn resume(     &mut self ) -> GeneratorState<<Box<T> as Generator>::Yield, <Box<T> as Generator>::Return>

[−]

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

Resumes the execution of this generator.

impl<T> BorrowMut<T> for Box<T> where     T: ?Sized,

[+]

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

[−]

Mutably borrows from an owned value.

impl<T> PartialOrd<Box<T>> for Box<T> where     T: PartialOrd<T> + ?Sized,

[+]

fn partial_cmp(&self, other: &Box<T>) -> Option<Ordering>

[−]

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

fn lt(&self, other: &Box<T>) -> bool

[−]

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

fn le(&self, other: &Box<T>) -> bool

[−]

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

fn ge(&self, other: &Box<T>) -> bool

[−]

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

fn gt(&self, other: &Box<T>) -> bool

[−]

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

impl<T> Debug for Box<T> where     T: Debug + ?Sized,

[+]

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

[−]

Formats the value using the given formatter.

impl<'a, E: Error + 'a> From<E> for Box<Error + 'a>

[+]

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>

[−]

Performs the conversion.

impl<'a, E: Error + Send + Sync + 'a> From<E> for Box<Error + Send + Sync + 'a>

[+]

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>

[−]

Performs the conversion.

impl From<String> for Box<Error + Send + Sync>

[+]

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>

[−]

Performs the conversion.

impl From<String> for Box<Error>

[+]

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>

[−]

Performs the conversion.

impl<'a, 'b> From<&'b str> for Box<Error + Send + Sync + 'a>

[+]

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>

[−]

Performs the conversion.

impl<'a> From<&'a str> for Box<Error>

[+]

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>

[−]

Performs the conversion.

impl<'a, 'b> From<Cow<'b, str>> for Box<Error + Send + Sync + 'a>

[+]

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>

[−]

Performs the conversion.

impl<'a> From<Cow<'a, str>> for Box<Error>

[+]

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>

[−]

Performs the conversion.

impl<T: Error> Error for Box<T>

[+]

fn description(&self) -> &str

[−]

A short description of the error.

fn cause(&self) -> Option<&Error>

[−]

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

impl<'a> From<&'a CStr> for Box<CStr>

[+]

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>

[−]

Performs the conversion.

impl From<Box<CStr>> for CString

[+]

fn from(s: Box<CStr>) -> CString

[−]

Performs the conversion.

impl From<CString> for Box<CStr>

[+]

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>

[−]

Performs the conversion.

impl Default for Box<CStr>

[+]

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>

[−]

Returns the "default value" for a type.

impl<'a> From<&'a OsStr> for Box<OsStr>

[+]

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>

[−]

Performs the conversion.

impl From<Box<OsStr>> for OsString

[+]

fn from(boxed: Box<OsStr>) -> OsString

[−]

Performs the conversion.

impl From<OsString> for Box<OsStr>

[+]

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>

[−]

Performs the conversion.

impl Default for Box<OsStr>

[+]

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>

[−]

Returns the "default value" for a type.

impl<R: Read + ?Sized> Read for Box<R>

[+]

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

[−]

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

unsafe fn initializer(&self) -> Initializer

[−]

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

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize>

[−]

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

fn read_to_string(&mut self, buf: &mut String) -> Result<usize>

[−]

Read all bytes until EOF in this source, appending them to buf.

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

[−]

Read the exact number of bytes required to fill buf.

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,

[−]

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

Important traits for Bytes<R>

impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;

fn bytes(self) -> Bytes<Self> where     Self: Sized,

[−]

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

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,

[−]

🔬 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.

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,

[−]

Creates an adaptor which will chain this stream with another.

Important traits for Take<T>

impl<T: Read> Read for Take<T>

fn take(self, limit: u64) -> Take<Self> where     Self: Sized,

[−]

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

impl<W: Write + ?Sized> Write for Box<W>

[+]

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

[−]

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

fn flush(&mut self) -> Result<()>

[−]

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

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

[−]

Attempts to write an entire buffer into this write.

fn write_fmt(&mut self, fmt: Arguments) -> Result<()>

[−]

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

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,

[−]

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

impl<S: Seek + ?Sized> Seek for Box<S>

[+]

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

[−]

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

impl<B: BufRead + ?Sized> BufRead for Box<B>

[+]

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

[−]

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

fn consume(&mut self, amt: usize)

[−]

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

fn read_until(&mut self, byte: u8, buf: &mut Vec<u8>) -> Result<usize>

[−]

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

fn read_line(&mut self, buf: &mut String) -> Result<usize>

[−]

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

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,

[−]

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

Important traits for Lines<B>

impl<B: BufRead> Iterator for Lines<B> type Item = Result<String>;

fn lines(self) -> Lines<Self> where     Self: Sized,

[−]

Returns an iterator over the lines of this reader.

impl<'a> From<&'a Path> for Box<Path>

[+]

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>

[−]

Performs the conversion.

impl From<Box<Path>> for PathBuf

[+]

fn from(boxed: Box<Path>) -> PathBuf

[−]

Performs the conversion.

impl From<PathBuf> for Box<Path>

[+]

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>

[−]

Performs the conversion.