W3cubDocs

/Rust

Struct std::boxed::Box

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

pub fn new(x: T) -> Box<T>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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>>[src]1.33.0

ⓘImportant traits for Pin<P>
impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future, 
    type Output = <<P as Deref>::Target as Future>::Output;

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> Box<T> where
    T: ?Sized
[src]

pub unsafe fn from_raw(raw: *mut T) -> Box<T>[src]1.4.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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. For this to be safe, the memory must have been allocated in accordance with the memory layout used by Box .

Safety

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

Recreate a Box which was previously converted to a raw pointer using Box::into_raw:

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

Manually create a Box from scratch by using the global allocator:

use std::alloc::{alloc, Layout};

unsafe {
    let ptr = alloc(Layout::new::<i32>()) as *mut i32;
    *ptr = 5;
    let x = Box::from_raw(ptr);
}

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

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, taking into account the memory layout used by Box. The easiest way to do this is to convert the raw pointer back into a Box with the Box::from_raw function, allowing the Box destructor to perform the cleanup.

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

Converting the raw pointer back into a Box with Box::from_raw for automatic cleanup:

let x = Box::new(String::from("Hello"));
let ptr = Box::into_raw(x);
let x = unsafe { Box::from_raw(ptr) };

Manual cleanup by explicitly running the destructor and deallocating the memory:

use std::alloc::{dealloc, Layout};
use std::ptr;

let x = Box::new(String::from("Hello"));
let p = Box::into_raw(x);
unsafe {
    ptr::drop_in_place(p);
    dealloc(p as *mut u8, Layout::new::<String>());
}

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

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

    // Clean up the memory by converting the NonNull pointer back
    // into a Box and letting the Box be dropped.
    let x = unsafe { Box::from_raw(ptr.as_ptr()) };
}

pub fn leak<'a>(b: Box<T>) -> &'a mut T where
    T: 'a, 
[src]1.26.0

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

ⓘImportant traits for Pin<P>
impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future, 
    type Output = <<P as Deref>::Target as Future>::Output;
🔬 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 + 'static>[src]

pub fn downcast<T>(self) -> Result<Box<T>, Box<dyn 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<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 + 'static + Send>[src]

pub fn downcast<T>(self) -> Result<Box<T>, Box<dyn 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<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> AsMut<T> for Box<T> where
    T: ?Sized
[src]1.5.0

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

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

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

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

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

The returned type after the call operator is used.

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

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

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

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

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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 String[src]1.18.0

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

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<T> From<T> for Box<T>[src]1.6.0

fn from(t: T) -> Box<T>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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 From<Box<str>> for Box<[u8]>[src]1.19.0

fn from(s: Box<str>) -> Box<[u8]>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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> From<&'_ [T]> for Box<[T]> where
    T: Copy
[src]1.17.0

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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<String> for Box<str>[src]1.20.0

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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 Pin<Box<T>> where
    T: ?Sized
[src]1.33.0

fn from(boxed: Box<T>) -> Pin<Box<T>>[src]

ⓘImportant traits for Pin<P>
impl<P> Future for Pin<P> where
    P: Unpin + DerefMut,
    <P as Deref>::Target: Future, 
    type Output = <<P as Deref>::Target as Future>::Output;

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

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

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

ⓘImportant traits for Vec<u8>
impl Write for Vec<u8>

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

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

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

Compares and returns the maximum of two values. Read more

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

Compares and returns the minimum of two values. Read more

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

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

Restrict a value to a certain interval. Read more

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

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

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

impl<I> FusedIterator for Box<I> where
    I: FusedIterator + ?Sized
[src]1.26.0

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

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

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

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

type Target = T

The resulting type after dereferencing.

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<T> Unpin for Box<T> where
    T: ?Sized
[src]1.33.0

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

fn clone(&self) -> Box<T>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

Performs copy-assignment from source. Read more

impl Clone for Box<str>[src]1.3.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

Performs copy-assignment from source. 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 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

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

ⓘImportant traits for StepBy<I>
impl<I> Iterator for StepBy<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

fn chain<U>(self, other: U) -> Chain<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator<Item = Self::Item>, 
[src]

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

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

fn zip<U>(self, other: U) -> Zip<Self, <U as IntoIterator>::IntoIter> where
    U: IntoIterator
[src]

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

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

fn map<B, F>(self, f: F) -> Map<Self, F> where
    F: FnMut(Self::Item) -> B, 
[src]

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

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), 
[src]1.21.0

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

fn filter<P>(self, predicate: P) -> Filter<Self, P> where
    P: FnMut(&Self::Item) -> bool
[src]

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

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

fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F> where
    F: FnMut(Self::Item) -> Option<B>, 
[src]

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

Creates an iterator that both filters and maps. Read more

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

ⓘImportant traits for Enumerate<I>
impl<I> Iterator for Enumerate<I> where
    I: Iterator, 
    type Item = (usize, <I as Iterator>::Item);

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

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

ⓘImportant traits for Peekable<I>
impl<I> Iterator for Peekable<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
[src]

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

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

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P> where
    P: FnMut(&Self::Item) -> bool
[src]

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

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

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

ⓘImportant traits for Skip<I>
impl<I> Iterator for Skip<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

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

ⓘImportant traits for Take<I>
impl<I> Iterator for Take<I> where
    I: Iterator, 
    type Item = <I as Iterator>::Item;

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

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]

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

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

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F> where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator
[src]

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

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

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

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

Creates an iterator that flattens nested structure. Read more

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

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

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

fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnMut(&Self::Item), 
[src]

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

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

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

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

Borrows an iterator, rather than consuming it. Read more

#[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>, 
[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]1.27.0

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

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

An iterator method that applies a fallible function to each item in the iterator, stopping at the first error and returning that error. 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 find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, 
[src]1.30.0

Applies function to the elements of iterator and returns the first non-none result. 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, 
[src]1.6.0

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
[src]1.15.0

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, 
[src]1.6.0

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
[src]1.15.0

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

fn rev(self) -> Rev<Self> where
    Self: DoubleEndedIterator
[src]

ⓘImportant traits for Rev<I>
impl<I> Iterator for Rev<I> where
    I: DoubleEndedIterator, 
    type Item = <I as Iterator>::Item;

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

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

ⓘImportant traits for Copied<I>
impl<'a, I, T> Iterator for Copied<I> where
    I: Iterator<Item = &'a T>,
    T: 'a + Copy, 
    type Item = T;

Creates an iterator which copies all of its elements. Read more

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

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

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

fn cycle(self) -> Cycle<Self> where
    Self: Clone
[src]

ⓘImportant traits for Cycle<I>
impl<I> Iterator for Cycle<I> where
    I: Clone + Iterator, 
    type Item = <I as Iterator>::Item;

Repeats an iterator endlessly. Read more

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

Sums the elements of an iterator. Read more

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

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
[src]1.5.0

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>, 
[src]1.5.0

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>, 
[src]1.5.0

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>, 
[src]1.5.0

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>, 
[src]1.5.0

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>, 
[src]1.5.0

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>, 
[src]1.5.0

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>, 
[src]1.5.0

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

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

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

Checks if the elements of this iterator are sorted. Read more

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

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

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

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

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

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<A> FromIterator<A> for Box<[A]>[src]1.32.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

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

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

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

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

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

impl Default for Box<str>[src]1.17.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

type Yield = <G as Generator>::Yield

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

The type of value this generator yields. Read more

type Return = <G as Generator>::Return

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

The type of value this generator returns. Read more

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

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

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

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

type Output = <F as Future>::Output

The type of value produced on completion.

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

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

fn by_ref(&mut self) -> &mut Self where
    Self: Sized
[src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

fn bytes(self) -> Bytes<Self> where
    Self: Sized
[src]

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

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

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

ⓘImportant traits for Chain<T, U>
impl<T: Read, U: Read> Read for Chain<T, U>

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

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

ⓘImportant traits for Take<T>
impl<T: Read> Read for Take<T>

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

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

fn by_ref(&mut self) -> &mut Self where
    Self: Sized
[src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

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

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

fn stream_len(&mut self) -> Result<u64>[src]

🔬 This is a nightly-only experimental API. (seek_convenience #59359)

Returns the length of this stream (in bytes). Read more

fn stream_position(&mut self) -> Result<u64>[src]

🔬 This is a nightly-only experimental API. (seek_convenience #59359)

Returns the current seek position from the start of the stream. Read more

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

fn split(self, byte: u8) -> Split<Self> where
    Self: Sized
[src]

ⓘImportant traits for Split<B>
impl<B: BufRead> Iterator for Split<B>
    type Item = Result<Vec<u8>>;

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

fn lines(self) -> Lines<Self> where
    Self: Sized
[src]

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

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

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

fn from(err: E) -> Box<dyn Error + 'a>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a type of Error into a box of dyn Error.

Examples

use std::error::Error;
use std::fmt;
use std::mem;

#[derive(Debug)]
struct AnError;

impl fmt::Display for AnError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f , "An error")
    }
}

impl Error for AnError {
    fn description(&self) -> &str {
        "Description of an error"
    }
}

let an_error = AnError;
assert!(0 == mem::size_of_val(&an_error));
let a_boxed_error = Box::<dyn Error>::from(an_error);
assert!(mem::size_of::<Box<dyn Error>>() == mem::size_of_val(&a_boxed_error))

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

fn from(err: E) -> Box<dyn Error + Send + Sync + 'a>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a type of Error + Send + Sync into a box of dyn Error + Send + Sync.

Examples

use std::error::Error;
use std::fmt;
use std::mem;

#[derive(Debug)]
struct AnError;

impl fmt::Display for AnError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f , "An error")
    }
}

impl Error for AnError {
    fn description(&self) -> &str {
        "Description of an error"
    }
}

unsafe impl Send for AnError {}

unsafe impl Sync for AnError {}

let an_error = AnError;
assert!(0 == mem::size_of_val(&an_error));
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(an_error);
assert!(
    mem::size_of::<Box<dyn Error + Send + Sync>>() == mem::size_of_val(&a_boxed_error))

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

fn from(err: String) -> Box<dyn Error + Send + Sync>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a String into a box of dyn Error + Send + Sync.

Examples

use std::error::Error;
use std::mem;

let a_string_error = "a string error".to_string();
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(a_string_error);
assert!(
    mem::size_of::<Box<dyn Error + Send + Sync>>() == mem::size_of_val(&a_boxed_error))

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

fn from(str_err: String) -> Box<dyn Error>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a String into a box of dyn Error.

Examples

use std::error::Error;
use std::mem;

let a_string_error = "a string error".to_string();
let a_boxed_error = Box::<dyn Error>::from(a_string_error);
assert!(mem::size_of::<Box<dyn Error>>() == mem::size_of_val(&a_boxed_error))

impl<'a, '_> From<&'_ str> for Box<dyn Error + Send + Sync + 'a>[src]

fn from(err: &str) -> Box<dyn Error + Send + Sync + 'a>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a str into a box of dyn Error + Send + Sync.

Examples

use std::error::Error;
use std::mem;

let a_str_error = "a str error";
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(a_str_error);
assert!(
    mem::size_of::<Box<dyn Error + Send + Sync>>() == mem::size_of_val(&a_boxed_error))

impl<'_> From<&'_ str> for Box<dyn Error>[src]1.6.0

fn from(err: &str) -> Box<dyn Error>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a str into a box of dyn Error.

Examples

use std::error::Error;
use std::mem;

let a_str_error = "a str error";
let a_boxed_error = Box::<dyn Error>::from(a_str_error);
assert!(mem::size_of::<Box<dyn Error>>() == mem::size_of_val(&a_boxed_error))

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

fn from(err: Cow<'b, str>) -> Box<dyn Error + Send + Sync + 'a>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a Cow into a box of dyn Error + Send + Sync.

Examples

use std::error::Error;
use std::mem;
use std::borrow::Cow;

let a_cow_str_error = Cow::from("a str error");
let a_boxed_error = Box::<dyn Error + Send + Sync>::from(a_cow_str_error);
assert!(
    mem::size_of::<Box<dyn Error + Send + Sync>>() == mem::size_of_val(&a_boxed_error))

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

fn from(err: Cow<'a, str>) -> Box<dyn Error>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a Cow into a box of dyn Error.

Examples

use std::error::Error;
use std::mem;
use std::borrow::Cow;

let a_cow_str_error = Cow::from("a str error");
let a_boxed_error = Box::<dyn Error>::from(a_cow_str_error);
assert!(mem::size_of::<Box<dyn Error>>() == mem::size_of_val(&a_boxed_error))

impl<'_> From<&'_ CStr> for Box<CStr>[src]1.17.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

Converts a Box<CStr> into a CString without copying or allocating.

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

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

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a CString into a Box<CStr> without copying or allocating.

impl<'_> From<&'_ OsStr> for Box<OsStr>[src]1.17.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

Converts a Box<OsStr> into a OsString without copying or allocating.

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

fn from(s: OsString) -> Box<OsStr>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a OsString into a Box<OsStr> without copying or allocating.

impl<'_> From<&'_ Path> for Box<Path>[src]1.17.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

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

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

Converts a Box<Path> into a PathBuf

This conversion does not allocate or copy memory.

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

fn from(p: PathBuf) -> Box<Path>[src]

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Converts a PathBuf into a Box<Path>

This conversion currently should not allocate memory, but this behavior is not guaranteed on all platforms or in all future versions.

impl Clone for Box<CStr>[src]1.29.0

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

Performs copy-assignment from source. Read more

impl Clone for Box<OsStr>[src]1.29.0

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

Performs copy-assignment from source. Read more

impl Clone for Box<Path>[src]1.29.0

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

Performs copy-assignment from source. Read more

impl Default for Box<CStr>[src]1.17.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

impl Default for Box<OsStr>[src]1.17.0

ⓘImportant traits for Box<I>
impl<I> Iterator for Box<I> where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<F> Future for Box<F> where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<R: Read + ?Sized> Read for Box<R>
impl<W: Write + ?Sized> Write for Box<W>

Auto Trait Implementations

impl<T: ?Sized> UnwindSafe for Box<T> where
    T: UnwindSafe

impl<T: ?Sized> RefUnwindSafe for Box<T> where
    T: RefUnwindSafe

impl<T: ?Sized> Send for Box<T> where
    T: Send

impl<T: ?Sized> Sync for Box<T> where
    T: Sync

Blanket Implementations

impl<'a, F> Pattern<'a> for F where
    F: FnMut(char) -> bool
[src]

type Searcher = CharPredicateSearcher<'a, F>

🔬 This is a nightly-only experimental API. (pattern #27721)API not fully fleshed out and ready to be stabilized

Associated searcher for this pattern

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<I> IntoIterator for I where
    I: Iterator
[src]

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = I

Which kind of iterator are we turning this into?

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> From<T> for T[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

ⓘImportant traits for &'_ mut F
impl<'_, F> Future for &'_ mut F where
    F: Unpin + Future + ?Sized, 
    type Output = <F as Future>::Output;
impl<'_, I> Iterator for &'_ mut I where
    I: Iterator + ?Sized, 
    type Item = <I as Iterator>::Item;
impl<'_, R: Read + ?Sized> Read for &'_ mut R
impl<'_, W: Write + ?Sized> Write for &'_ mut W

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

impl<T> ToString for T where
    T: Display + ?Sized
[src]

© 2010 The Rust Project Developers
Licensed under the Apache License, Version 2.0 or the MIT license, at your option.
https://doc.rust-lang.org/std/boxed/struct.Box.html