Struct alloc::boxed::Box

[+] Show declaration

[+] Expand attributes
#[lang = "owned_box"]
pub struct Box<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 + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

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

pub fn pin(x: T) -> Pin<Box<T>>[−]

Constructs a new Pin<Box<T>>. If T does not implement Unpin, then x will be pinned in memory and unable to be moved.

impl<T: ?Sized> Box<T>[−]

pub unsafe fn from_raw(raw: *mut T) -> Self[−]

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 a wrapped raw pointer.

The pointer will be properly aligned and non-null.

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 leak<'a>(b: Box<T>) -> &'a mut T where
    T: 'a, [−]

Consumes and leaks the Box, returning a mutable reference, &'a mut T. Note that the type T must outlive the chosen lifetime 'a. If the type has only static references, or none at all, then this 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]);
}

pub fn into_pin(boxed: Box<T>) -> Pin<Box<T>>[−]

🔬 This is a nightly-only experimental API. (box_into_pin #0)

Converts a Box<T> into a Pin<Box<T>>

This conversion does not allocate on the heap and happens in place.

This is also available via From.

impl Box<dyn Any>[−]

pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<dyn Any>>[−]

Attempt to downcast the box to a concrete type.

Examples

use std::any::Any;

fn print_if_string(value: Box<dyn 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<dyn Any + Send>[−]

pub fn downcast<T: Any>(self) -> Result<Box<T>, Box<dyn Any + Send>>[−]

Attempt to downcast the box to a concrete type.

Examples

use std::any::Any;

fn print_if_string(value: Box<dyn 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<T: ?Sized + PartialEq> PartialEq<Box<T>> for Box<T>[+]

[+] Show hidden undocumented items

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<T: ?Sized + Eq> Eq for Box<T>

impl<T: ?Sized + Ord> Ord for Box<T>[+]

[+] Show hidden undocumented items

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.

fn clamp(self, min: Self, max: Self) -> Self[−]

🔬 This is a nightly-only experimental API. (clamp #44095)

Restrict a value to a certain interval.

impl<T: ?Sized + PartialOrd> PartialOrd<Box<T>> for Box<T>[+]

[+] Show hidden undocumented items

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: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Box<U>> for Box<T>

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

fn from(t: T) -> Self[−]

Converts a generic type T into a Box<T>

The conversion allocates on the heap and moves t from the stack into it.

Examples

let x = 5;
let boxed = Box::new(5);

assert_eq!(Box::from(x), boxed);

impl<T: ?Sized> From<Box<T>> for Pin<Box<T>>[+]

fn from(boxed: Box<T>) -> Self[−]

Converts a Box<T> into a Pin<Box<T>>

This conversion does not allocate on the heap and happens in place.

impl<T: Copy, '_> From<&'_ [T]> for Box<[T]>[+]

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

fn from(slice: &[T]) -> Box<[T]>[−]

Converts a &[T] into a Box<[T]>

This conversion allocates on the heap and performs a copy of slice.

Examples

// create a &[u8] which will be used to create a Box<[u8]>
let slice: &[u8] = &[104, 101, 108, 108, 111];
let boxed_slice: Box<[u8]> = Box::from(slice);

println!("{:?}", boxed_slice);

impl<'_> From<&'_ str> for Box<str>[+]

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

fn from(s: &str) -> Box<str>[−]

Converts a &str into a Box<str>

This conversion allocates on the heap and performs a copy of s.

Examples

let boxed: Box<str> = Box::from("hello");
println!("{}", boxed);

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

fn from(s: Box<str>) -> Self[−]

Converts a Box<str>> into a Box<[u8]>

This conversion does not allocate on the heap and happens in place.

Examples

// create a Box<str> which will be used to create a Box<[u8]>
let boxed: Box<str> = Box::from("hello");
let boxed_str: Box<[u8]> = Box::from(boxed);

// create a &[u8] which will be used to create a Box<[u8]>
let slice: &[u8] = &[104, 101, 108, 108, 111];
let boxed_slice = Box::from(slice);

assert_eq!(boxed_slice, boxed_str);

impl<T: ?Sized> From<Box<T>> for Arc<T>[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl<T: ?Sized> From<Box<T>> for Rc<T>[+]

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<Box<str>> for String[+]

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

Converts the given boxed str slice to a String. It is notable that the str slice is owned.

Examples

Basic usage:

let s1: String = String::from("hello world");
let s2: Box<str> = s1.into_boxed_str();
let s3: String = String::from(s2);

assert_eq!("hello world", s3)

impl From<String> for Box<str>[+]

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

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

Converts the given String to a boxed str slice that is owned.

Examples

Basic usage:

let s1: String = String::from("hello world");
let s2: Box<str> = Box::from(s1);
let s3: String = String::from(s2);

assert_eq!("hello world", s3)

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

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

Performs the conversion.

impl<T: Debug + ?Sized> Debug for Box<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<T: Display + ?Sized> Display for Box<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<T: ?Sized> Deref for Box<T>[+]

[+] Show hidden undocumented items

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T[−]

Dereferences the value.

impl<T: ?Sized> DerefMut for Box<T>[+]

[+] Show hidden undocumented items

fn deref_mut(&mut self) -> &mut T[−]

Mutably dereferences the value.

impl<T: ?Sized> Receiver for Box<T>

impl<T: ?Sized> Drop for Box<T>[+]

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

impl<A, F: Fn<A> + ?Sized> Fn<A> for Box<F>[+]

[+] Show hidden undocumented items

extern "rust-call" fn call(&self, args: A) -> Self::Output[−]

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

Performs the call operation.

impl<A, F: FnMut<A> + ?Sized> FnMut<A> for Box<F>[+]

[+] Show hidden undocumented items

extern "rust-call" fn call_mut(&mut self, args: A) -> Self::Output[−]

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

Performs the call operation.

impl<A, F: FnOnce<A> + ?Sized> FnOnce<A> for Box<F>[+]

[+] Show hidden undocumented items

type Output = <F as FnOnce<A>>::Output

The returned type after the call operator is used.

extern "rust-call" fn call_once(self, args: A) -> Self::Output[−]

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

Performs the call operation.

impl<G: ?Sized + Generator + Unpin> Generator for Box<G>[+]

[+] Show hidden undocumented items

type Yield = G::Yield

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

The type of value this generator yields.

type Return = G::Return

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

The type of value this generator returns.

fn resume(self: Pin<&mut Self>) -> GeneratorState<Self::Yield, Self::Return>[−]

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

Resumes the execution of this generator.

impl<T: ?Sized> Unpin for Box<T>

impl<T: ?Sized + Hash> Hash for Box<T>[+]

[+] Show hidden undocumented items

fn hash<H: Hasher>(&self, state: &mut H)[−]

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: ?Sized + Hasher> Hasher for Box<T>[+]

[+] Show hidden undocumented items

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: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Box<U>> for Box<T>

impl<A> FromIterator<A> for Box<[A]>[+]

[+] Show hidden undocumented items

fn from_iter<T: IntoIterator<Item = A>>(iter: T) -> Self[−]

Creates a value from an iterator.

impl<I: Iterator + ?Sized> Iterator for Box<I>[+]

[+] Show hidden undocumented items

type Item = I::Item

The type of the elements being iterated over.

fn next(&mut self) -> Option<I::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::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.

fn step_by(self, step: usize) -> StepBy<Self>[−]

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

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.

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.

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.

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.

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.

fn enumerate(self) -> Enumerate<Self>[−]

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

fn peekable(self) -> Peekable<Self>[−]

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

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.

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.

fn skip(self, n: usize) -> Skip<Self>[−]

Creates an iterator that skips the first n elements.

fn take(self, n: usize) -> Take<Self>[−]

Creates an iterator that yields its first n elements.

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.

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.

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

Creates an iterator that flattens nested structure.

fn fuse(self) -> Fuse<Self>[−]

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

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.

fn by_ref(&mut self) -> &mut Self[−]

Borrows an iterator, rather than consuming it.

[+] Expand attributes

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]

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>, [−]

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 = ()>, [−]

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 find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, [−]

Applies function to the elements of iterator and returns the first non-none result.

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.

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.

fn copied<'a, T>(self) -> Copied<Self> where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy, [−]

Creates an iterator which copies all of its elements.

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.

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.

fn is_sorted(self) -> bool where
    Self::Item: PartialOrd<Self::Item>, [−]

🔬 This is a nightly-only experimental API. (is_sorted #53485)

new API

Checks if the elements of this iterator are sorted.

fn is_sorted_by<F>(self, compare: F) -> bool where
    F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>, [−]

🔬 This is a nightly-only experimental API. (is_sorted #53485)

new API

Checks if the elements of this iterator are sorted using the given comparator function.

fn is_sorted_by_key<F, K>(self, f: F) -> bool where
    F: FnMut(&Self::Item) -> K,
    K: PartialOrd<K>, [−]

🔬 This is a nightly-only experimental API. (is_sorted #53485)

new API

Checks if the elements of this iterator are sorted using the given key extraction function.

impl<I: ExactSizeIterator + ?Sized> ExactSizeIterator for Box<I>[+]

[+] Show hidden undocumented items

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 true if the iterator is empty.

impl<I: DoubleEndedIterator + ?Sized> DoubleEndedIterator for Box<I>[+]

[+] Show hidden undocumented items

fn next_back(&mut self) -> Option<I::Item>[−]

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

fn nth_back(&mut self, n: usize) -> Option<I::Item>[−]

🔬 This is a nightly-only experimental API. (iter_nth_back #56995)

Returns the nth 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 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, [−]

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, [−]

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

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

impl<T: ?Sized> AsRef<T> for Box<T>[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &T[−]

Performs the conversion.

impl<T: ?Sized> AsMut<T> for Box<T>[+]

[+] Show hidden undocumented items

fn as_mut(&mut self) -> &mut T[−]

Performs the conversion.

impl<T: ?Sized> Pointer for Box<T>[+]

[+] Show hidden undocumented items

fn fmt(&self, f: &mut Formatter) -> Result[−]

Formats the value using the given formatter.

impl<T: Clone> Clone for Box<T>[+]

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

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 Clone for Box<str>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl<T: Clone> Clone for Box<[T]>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Self[−]

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

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

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

fn default() -> Box<T>[−]

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

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

[+] Show hidden undocumented items

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

fn default() -> Box<[T]>[−]

Returns the "default value" for a type.

impl Default for Box<str>[+]

[+] Show hidden undocumented items

Important traits for Box<I>

impl<I: Iterator + ?Sized> Iterator for Box<I> type Item = I::Item;impl<F: ?Sized + Future + Unpin> Future for Box<F> type Output = F::Output;

fn default() -> Box<str>[−]

Returns the "default value" for a type.

impl<T: ?Sized> Borrow<T> for Box<T>[+]

[+] Show hidden undocumented items

fn borrow(&self) -> &T[−]

Immutably borrows from an owned value.

impl<T: ?Sized> BorrowMut<T> for Box<T>[+]

[+] Show hidden undocumented items

fn borrow_mut(&mut self) -> &mut T[−]

Mutably borrows from an owned value.

impl<F: ?Sized + Future + Unpin> Future for Box<F>[+]

[+] Show hidden undocumented items

type Output = F::Output

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>[−]

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.