Struct std::boxed::Box1.0.0[][src]

pub struct Box<T, A = Global>(_, _)
where
    T: ?Sized,
    A: Allocator
;
Expand description

A pointer type for heap allocation.

See the module-level documentation for more.

Implementations

impl<T> Box<T, Global>[src]

pub fn new(x: T) -> Box<T, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

Examples

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

pub fn new_uninit() -> Box<MaybeUninit<T>, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (new_uninit #63291)

Constructs a new box with uninitialized contents.

Examples

#![feature(new_uninit)]

let mut five = Box::<u32>::new_uninit();

let five = unsafe {
    // Deferred initialization:
    five.as_mut_ptr().write(5);

    five.assume_init()
};

assert_eq!(*five, 5)
Run

pub fn new_zeroed() -> Box<MaybeUninit<T>, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (new_uninit #63291)

Constructs a new Box with uninitialized contents, with the memory being filled with 0 bytes.

See MaybeUninit::zeroed for examples of correct and incorrect usage of this method.

Examples

#![feature(new_uninit)]

let zero = Box::<u32>::new_zeroed();
let zero = unsafe { zero.assume_init() };

assert_eq!(*zero, 0)
Run

pub fn pin(x: T) -> Pin<Box<T, Global>>

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

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

pub fn try_new(x: T) -> Result<Box<T, Global>, AllocError>[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Allocates memory on the heap then places x into it, returning an error if the allocation fails

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

Examples

#![feature(allocator_api)]

let five = Box::try_new(5)?;
Run

pub fn try_new_uninit() -> Result<Box<MaybeUninit<T>, Global>, AllocError>[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new box with uninitialized contents on the heap, returning an error if the allocation fails

Examples

#![feature(allocator_api, new_uninit)]

let mut five = Box::<u32>::try_new_uninit()?;

let five = unsafe {
    // Deferred initialization:
    five.as_mut_ptr().write(5);

    five.assume_init()
};

assert_eq!(*five, 5);
Run

pub fn try_new_zeroed() -> Result<Box<MaybeUninit<T>, Global>, AllocError>[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new Box with uninitialized contents, with the memory being filled with 0 bytes on the heap

See MaybeUninit::zeroed for examples of correct and incorrect usage of this method.

Examples

#![feature(allocator_api, new_uninit)]

let zero = Box::<u32>::try_new_zeroed()?;
let zero = unsafe { zero.assume_init() };

assert_eq!(*zero, 0);
Run

impl<T, A> Box<T, A> where
    A: Allocator
[src]

pub fn new_in(x: T, alloc: A) -> Box<T, A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Allocates memory in the given allocator then places x into it.

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

Examples

#![feature(allocator_api)]

use std::alloc::System;

let five = Box::new_in(5, System);
Run

pub fn try_new_in(x: T, alloc: A) -> Result<Box<T, A>, AllocError>[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Allocates memory in the given allocator then places x into it, returning an error if the allocation fails

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

Examples

#![feature(allocator_api)]

use std::alloc::System;

let five = Box::try_new_in(5, System)?;
Run

pub fn new_uninit_in(alloc: A) -> Box<MaybeUninit<T>, A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new box with uninitialized contents in the provided allocator.

Examples

#![feature(allocator_api, new_uninit)]

use std::alloc::System;

let mut five = Box::<u32, _>::new_uninit_in(System);

let five = unsafe {
    // Deferred initialization:
    five.as_mut_ptr().write(5);

    five.assume_init()
};

assert_eq!(*five, 5)
Run

pub fn try_new_uninit_in(alloc: A) -> Result<Box<MaybeUninit<T>, A>, AllocError>[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new box with uninitialized contents in the provided allocator, returning an error if the allocation fails

Examples

#![feature(allocator_api, new_uninit)]

use std::alloc::System;

let mut five = Box::<u32, _>::try_new_uninit_in(System)?;

let five = unsafe {
    // Deferred initialization:
    five.as_mut_ptr().write(5);

    five.assume_init()
};

assert_eq!(*five, 5);
Run

pub fn new_zeroed_in(alloc: A) -> Box<MaybeUninit<T>, A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new Box with uninitialized contents, with the memory being filled with 0 bytes in the provided allocator.

See MaybeUninit::zeroed for examples of correct and incorrect usage of this method.

Examples

#![feature(allocator_api, new_uninit)]

use std::alloc::System;

let zero = Box::<u32, _>::new_zeroed_in(System);
let zero = unsafe { zero.assume_init() };

assert_eq!(*zero, 0)
Run

pub fn try_new_zeroed_in(alloc: A) -> Result<Box<MaybeUninit<T>, A>, AllocError>[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new Box with uninitialized contents, with the memory being filled with 0 bytes in the provided allocator, returning an error if the allocation fails,

See MaybeUninit::zeroed for examples of correct and incorrect usage of this method.

Examples

#![feature(allocator_api, new_uninit)]

use std::alloc::System;

let zero = Box::<u32, _>::try_new_zeroed_in(System)?;
let zero = unsafe { zero.assume_init() };

assert_eq!(*zero, 0);
Run

pub fn pin_in(x: T, alloc: A) -> Pin<Box<T, A>>

Notable 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;
where
    A: 'static, 
[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

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

pub fn into_boxed_slice(boxed: Box<T, A>) -> Box<[T], A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (box_into_boxed_slice #71582)

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

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

pub fn into_inner(boxed: Box<T, A>) -> T[src]

🔬 This is a nightly-only experimental API. (box_into_inner #80437)

Consumes the Box, returning the wrapped value.

Examples

#![feature(box_into_inner)]

let c = Box::new(5);

assert_eq!(Box::into_inner(c), 5);
Run

impl<T> Box<[T], Global>[src]

pub fn new_uninit_slice(len: usize) -> Box<[MaybeUninit<T>], Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (new_uninit #63291)

Constructs a new boxed slice with uninitialized contents.

Examples

#![feature(new_uninit)]

let mut values = Box::<[u32]>::new_uninit_slice(3);

let values = unsafe {
    // Deferred initialization:
    values[0].as_mut_ptr().write(1);
    values[1].as_mut_ptr().write(2);
    values[2].as_mut_ptr().write(3);

    values.assume_init()
};

assert_eq!(*values, [1, 2, 3])
Run

pub fn new_zeroed_slice(len: usize) -> Box<[MaybeUninit<T>], Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (new_uninit #63291)

Constructs a new boxed slice with uninitialized contents, with the memory being filled with 0 bytes.

See MaybeUninit::zeroed for examples of correct and incorrect usage of this method.

Examples

#![feature(new_uninit)]

let values = Box::<[u32]>::new_zeroed_slice(3);
let values = unsafe { values.assume_init() };

assert_eq!(*values, [0, 0, 0])
Run

impl<T, A> Box<[T], A> where
    A: Allocator
[src]

pub fn new_uninit_slice_in(len: usize, alloc: A) -> Box<[MaybeUninit<T>], A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new boxed slice with uninitialized contents in the provided allocator.

Examples

#![feature(allocator_api, new_uninit)]

use std::alloc::System;

let mut values = Box::<[u32], _>::new_uninit_slice_in(3, System);

let values = unsafe {
    // Deferred initialization:
    values[0].as_mut_ptr().write(1);
    values[1].as_mut_ptr().write(2);
    values[2].as_mut_ptr().write(3);

    values.assume_init()
};

assert_eq!(*values, [1, 2, 3])
Run

pub fn new_zeroed_slice_in(len: usize, alloc: A) -> Box<[MaybeUninit<T>], A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a new boxed slice with uninitialized contents in the provided allocator, with the memory being filled with 0 bytes.

See MaybeUninit::zeroed for examples of correct and incorrect usage of this method.

Examples

#![feature(allocator_api, new_uninit)]

use std::alloc::System;

let values = Box::<[u32], _>::new_zeroed_slice_in(3, System);
let values = unsafe { values.assume_init() };

assert_eq!(*values, [0, 0, 0])
Run

impl<T, A> Box<MaybeUninit<T>, A> where
    A: Allocator
[src]

pub unsafe fn assume_init(self) -> Box<T, A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (new_uninit #63291)

Converts to Box<T, A>.

Safety

As with MaybeUninit::assume_init, it is up to the caller to guarantee that the value really is in an initialized state. Calling this when the content is not yet fully initialized causes immediate undefined behavior.

Examples

#![feature(new_uninit)]

let mut five = Box::<u32>::new_uninit();

let five: Box<u32> = unsafe {
    // Deferred initialization:
    five.as_mut_ptr().write(5);

    five.assume_init()
};

assert_eq!(*five, 5)
Run

impl<T, A> Box<[MaybeUninit<T>], A> where
    A: Allocator
[src]

pub unsafe fn assume_init(self) -> Box<[T], A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (new_uninit #63291)

Converts to Box<[T], A>.

Safety

As with MaybeUninit::assume_init, it is up to the caller to guarantee that the values really are in an initialized state. Calling this when the content is not yet fully initialized causes immediate undefined behavior.

Examples

#![feature(new_uninit)]

let mut values = Box::<[u32]>::new_uninit_slice(3);

let values = unsafe {
    // Deferred initialization:
    values[0].as_mut_ptr().write(1);
    values[1].as_mut_ptr().write(2);
    values[2].as_mut_ptr().write(3);

    values.assume_init()
};

assert_eq!(*values, [1, 2, 3])
Run

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

pub unsafe fn from_raw(raw: *mut T) -> Box<T, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
1.4.0[src]

Constructs a box from a raw pointer.

After calling this function, the raw pointer is owned by the resulting Box. Specifically, the Box destructor will call the destructor of T and free the allocated memory. 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.

The safety conditions are described in the memory layout section.

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

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;
    // In general .write is required to avoid attempting to destruct
    // the (uninitialized) previous contents of `ptr`, though for this
    // simple example `*ptr = 5` would have worked as well.
    ptr.write(5);
    let x = Box::from_raw(ptr);
}
Run

impl<T, A> Box<T, A> where
    T: ?Sized,
    A: Allocator
[src]

pub unsafe fn from_raw_in(raw: *mut T, alloc: A) -> Box<T, A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Constructs a box from a raw pointer in the given allocator.

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_with_allocator:

#![feature(allocator_api)]

use std::alloc::System;

let x = Box::new_in(5, System);
let (ptr, alloc) = Box::into_raw_with_allocator(x);
let x = unsafe { Box::from_raw_in(ptr, alloc) };
Run

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

#![feature(allocator_api, slice_ptr_get)]

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

unsafe {
    let ptr = System.allocate(Layout::new::<i32>())?.as_mut_ptr() as *mut i32;
    // In general .write is required to avoid attempting to destruct
    // the (uninitialized) previous contents of `ptr`, though for this
    // simple example `*ptr = 5` would have worked as well.
    ptr.write(5);
    let x = Box::from_raw_in(ptr, System);
}
Run

pub fn into_raw(b: Box<T, A>) -> *mut T1.4.0[src]

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

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

pub fn into_raw_with_allocator(b: Box<T, A>) -> (*mut T, A)[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Consumes the Box, returning a wrapped raw pointer and the allocator.

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_in 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_with_allocator(b) instead of b.into_raw_with_allocator(). 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_in for automatic cleanup:

#![feature(allocator_api)]

use std::alloc::System;

let x = Box::new_in(String::from("Hello"), System);
let (ptr, alloc) = Box::into_raw_with_allocator(x);
let x = unsafe { Box::from_raw_in(ptr, alloc) };
Run

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

#![feature(allocator_api)]

use std::alloc::{Allocator, Layout, System};
use std::ptr::{self, NonNull};

let x = Box::new_in(String::from("Hello"), System);
let (ptr, alloc) = Box::into_raw_with_allocator(x);
unsafe {
    ptr::drop_in_place(ptr);
    let non_null = NonNull::new_unchecked(ptr);
    alloc.deallocate(non_null.cast(), Layout::new::<String>());
}
Run

pub fn allocator(b: &Box<T, A>) -> &A[src]

🔬 This is a nightly-only experimental API. (allocator_api #32838)

Returns a reference to the underlying allocator.

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

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

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:

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

Unsized data:

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

pub fn into_pin(boxed: Box<T, A>) -> Pin<Box<T, A>>

Notable 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;
where
    A: 'static, 
[src]

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

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<A> Box<dyn Any + 'static, A> where
    A: Allocator
[src]

pub fn downcast<T>(self) -> Result<Box<T, A>, Box<dyn Any + 'static, A>> 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);
    }
}

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

impl<A> Box<dyn Any + 'static + Send, A> where
    A: Allocator
[src]

pub fn downcast<T>(self) -> Result<Box<T, A>, Box<dyn Any + 'static + Send, A>> 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);
    }
}

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

impl<A> Box<dyn Any + 'static + Send + Sync, A> where
    A: Allocator
[src]

pub fn downcast<T>(
    self
) -> Result<Box<T, A>, Box<dyn Any + 'static + Send + Sync, A>> where
    T: Any
1.51.0[src]

Attempt to downcast the box to a concrete type.

Examples

use std::any::Any;

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

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

Trait Implementations

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

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

Performs the conversion.

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

pub fn as_ref(&self) -> &T[src]

Performs the conversion.

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

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

Returns the contents of the internal buffer, filling it with more data from the inner reader if it is empty. Read more

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

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

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

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

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

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

fn split(self, byte: u8) -> Split<Self>

Notable traits for Split<B>

impl<B: BufRead> Iterator for Split<B> type Item = Result<Vec<u8>>;
where
    Self: Sized
[src]

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

fn lines(self) -> Lines<Self>

Notable traits for Lines<B>

impl<B: BufRead> Iterator for Lines<B> type Item = Result<String>;
where
    Self: Sized
[src]

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

impl Clone for Box<str, Global>1.3.0[src]

pub fn clone(&self) -> Box<str, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

impl<T, A> Clone for Box<T, A> where
    T: Clone,
    A: Allocator + Clone
[src]

pub fn clone(&self) -> Box<T, A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

Examples

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

// The value is the same
assert_eq!(x, y);

// But they are unique objects
assert_ne!(&*x as *const i32, &*y as *const i32);
Run

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

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

Examples

let x = Box::new(5);
let mut y = Box::new(10);
let yp: *const i32 = &*y;

y.clone_from(&x);

// The value is the same
assert_eq!(x, y);

// And no allocation occurred
assert_eq!(yp, &*y);
Run

impl<T, A> Clone for Box<[T], A> where
    T: Clone,
    A: Allocator + Clone
1.3.0[src]

pub fn clone(&self) -> Box<[T], A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Returns a copy of the value. Read more

pub fn clone_from(&mut self, other: &Box<[T], A>)[src]

Performs copy-assignment from source. Read more

impl Clone for Box<CStr>1.29.0[src]

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

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

impl Clone for Box<OsStr>1.29.0[src]

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

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

impl Clone for Box<Path>1.29.0[src]

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

Returns a copy of the value. Read more

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

Performs copy-assignment from source. Read more

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

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

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

pub fn default() -> Box<[T], Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Returns the “default value” for a type. Read more

impl Default for Box<str, Global>1.17.0[src]

pub fn default() -> Box<str, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Returns the “default value” for a type. Read more

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

pub fn default() -> Box<T, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

impl Default for Box<CStr>1.17.0[src]

fn default() -> Box<CStr>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Returns the “default value” for a type. Read more

impl Default for Box<OsStr>1.17.0[src]

fn default() -> Box<OsStr>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Returns the “default value” for a type. Read more

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

type Target = T

The resulting type after dereferencing.

pub fn deref(&self) -> &T[src]

Dereferences the value.

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

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

Mutably dereferences the value.

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

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter. Read more

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

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

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

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

Returns the nth element from the end of the iterator. Read more

fn advance_back_by(&mut self, n: usize) -> Result<(), usize>[src]

🔬 This is a nightly-only experimental API. (iter_advance_by #77404)

recently added

Advances the iterator from the back by n elements. Read more

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

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

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

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

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

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

pub fn drop(&mut self)[src]

Executes the destructor for this type. Read more

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

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

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn source(&self) -> Option<&(dyn Error + 'static)>[src]

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

fn backtrace(&self) -> Option<&Backtrace>[src]

🔬 This is a nightly-only experimental API. (backtrace #53487)

Returns a stack backtrace, if available, of where this error occurred. Read more

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

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

Returns the exact length of the iterator. Read more

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

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

Returns true if the iterator is empty. Read more

impl Extend<Box<str, Global>> for String1.45.0[src]

pub fn extend<I>(&mut self, iter: I) where
    I: IntoIterator<Item = Box<str, Global>>, 
[src]

Extends a collection with the contents of an iterator. Read more

fn extend_one(&mut self, item: A)[src]

🔬 This is a nightly-only experimental API. (extend_one #72631)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)[src]

🔬 This is a nightly-only experimental API. (extend_one #72631)

Reserves capacity in a collection for the given number of additional elements. Read more

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

pub extern "rust-call" fn call(
    &self,
    args: Args
) -> <Box<F, A> as FnOnce<Args>>::Output

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

Performs the call operation.

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

pub extern "rust-call" fn call_mut(
    &mut self,
    args: Args
) -> <Box<F, A> as FnOnce<Args>>::Output

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

Performs the call operation.

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

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

The returned type after the call operator is used.

pub extern "rust-call" fn call_once(
    self,
    args: Args
) -> <Box<F, A> as FnOnce<Args>>::Output

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

Performs the call operation.

impl<'_, T> From<&'_ [T]> for Box<[T], Global> where
    T: Copy
1.17.0[src]

pub fn from(slice: &[T]) -> Box<[T], Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

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

fn from(s: &OsStr) -> Box<OsStr>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

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

fn from(path: &Path) -> Box<Path>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

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

pub fn from(s: &str) -> Box<str, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

impl<T, const N: usize> From<[T; N]> for Box<[T], Global>1.45.0[src]

pub fn from(array: [T; N]) -> Box<[T], Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Converts a [T; N] into a Box<[T]>

This conversion moves the array to newly heap-allocated memory.

Examples

let boxed: Box<[u8]> = Box::from([4, 2]);
println!("{:?}", boxed);
Run

impl<T, A> From<Box<[T], A>> for Vec<T, A> where
    A: Allocator
1.18.0[src]

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

Notable traits for Vec<u8, A>

impl<A: Allocator> Write for Vec<u8, A>
[src]

Convert a boxed slice into a vector by transferring ownership of the existing heap allocation.

Examples

let b: Box<[i32]> = vec![1, 2, 3].into_boxed_slice();
assert_eq!(Vec::from(b), vec![1, 2, 3]);
Run

impl From<Box<CStr, Global>> for CString1.18.0[src]

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

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

impl From<Box<OsStr, Global>> for OsString1.18.0[src]

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

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

impl From<Box<Path, Global>> for PathBuf1.18.0[src]

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

Converts a Box<Path> into a PathBuf

This conversion does not allocate or copy memory.

impl<T, A> From<Box<T, A>> for Pin<Box<T, A>> where
    T: ?Sized,
    A: Allocator + 'static, 
1.33.0[src]

pub fn from(boxed: Box<T, A>) -> Pin<Box<T, A>>

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

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, Global>> for Arc<T> where
    T: ?Sized
1.21.0[src]

pub fn from(v: Box<T, Global>) -> Arc<T>[src]

Move a boxed object to a new, reference-counted allocation.

Example

let unique: Box<str> = Box::from("eggplant");
let shared: Arc<str> = Arc::from(unique);
assert_eq!("eggplant", &shared[..]);
Run

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

pub fn from(v: Box<T, Global>) -> Rc<T>[src]

Move a boxed object to a new, reference counted, allocation.

Example

let original: Box<i32> = Box::new(1);
let shared: Rc<i32> = Rc::from(original);
assert_eq!(1, *shared);
Run

impl<A> From<Box<str, A>> for Box<[u8], A> where
    A: Allocator
1.19.0[src]

pub fn from(s: Box<str, A>) -> Box<[u8], A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

impl From<Box<str, Global>> for String1.18.0[src]

pub fn from(s: Box<str, Global>) -> 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)
Run

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

impl<'_, T> From<Cow<'_, [T]>> for Box<[T], Global> where
    T: Copy
1.45.0[src]

pub fn from(cow: Cow<'_, [T]>) -> Box<[T], Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

impl From<Cow<'_, CStr>> for Box<CStr>1.45.0[src]

fn from(cow: Cow<'_, CStr>) -> Box<CStr>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

impl From<Cow<'_, OsStr>> for Box<OsStr>1.45.0[src]

fn from(cow: Cow<'_, OsStr>) -> Box<OsStr>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

impl From<Cow<'_, Path>> for Box<Path>1.45.0[src]

fn from(cow: Cow<'_, Path>) -> Box<Path>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

impl<'_> From<Cow<'_, str>> for Box<str, Global>1.45.0[src]

pub fn from(cow: Cow<'_, str>) -> Box<str, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Performs the conversion.

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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 {}

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

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>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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 {}

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

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

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

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

impl<T> From<T> for Box<T, Global>1.6.0[src]

pub fn from(t: T) -> Box<T, Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

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

impl<T, A> From<Vec<T, A>> for Box<[T], A> where
    A: Allocator
1.20.0[src]

pub fn from(v: Vec<T, A>) -> Box<[T], A>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
[src]

Convert a vector into a boxed slice.

If v has excess capacity, its items will be moved into a newly-allocated buffer with exactly the right capacity.

Examples

assert_eq!(Box::from(vec![1, 2, 3]), vec![1, 2, 3].into_boxed_slice());
Run

impl FromIterator<Box<str, Global>> for String1.45.0[src]

pub fn from_iter<I>(iter: I) -> String where
    I: IntoIterator<Item = Box<str, Global>>, 
[src]

Creates a value from an iterator. Read more

impl<I> FromIterator<I> for Box<[I], Global>1.32.0[src]

pub fn from_iter<T>(iter: T) -> Box<[I], Global>

Notable traits for Box<F, A>

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
type Output = <F as Future>::Output;impl<I, A> Iterator for Box<I, A> where
    I: Iterator + ?Sized,
    A: Allocator
type Item = <I as Iterator>::Item;impl<R: Read + ?Sized> Read for Box<R>impl<W: Write + ?Sized> Write for Box<W>
where
    T: IntoIterator<Item = I>, 
[src]

Creates a value from an iterator. Read more

impl<F, A> Future for Box<F, A> where
    F: Future + Unpin + ?Sized,
    A: Allocator + 'static, 
1.36.0[src]

type Output = <F as Future>::Output

The type of value produced on completion.

pub fn poll(
    self: Pin<&mut Box<F, A>>,
    cx: &mut Context<'_>
) -> Poll<<Box<F, A> as Future>::Output>
[src]

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

impl<G, R, A> Generator<R> for Box<G, A> where
    A: Allocator + 'static,
    G: Generator<R> + Unpin + ?Sized
[src]

type Yield = <G as Generator<R>>::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<R>>::Return

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

The type of value this generator returns. Read more

pub fn resume(
    self: Pin<&mut Box<G, A>>,
    arg: R
) -> GeneratorState<<Box<G, A> as Generator<R>>::Yield, <Box<G, A> as Generator<R>>::Return>
[src]

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

Resumes the execution of this generator. Read more

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

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

Feeds this value into the given Hasher. Read more

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

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

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

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

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

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

Writes some data into this Hasher. Read more

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

Writes a single u8 into this hasher.

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

Writes a single u16 into this hasher.

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

Writes a single u32 into this hasher.

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

Writes a single u64 into this hasher.

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

Writes a single u128 into this hasher.

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

Writes a single usize into this hasher.

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

Writes a single i8 into this hasher.

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

Writes a single i16 into this hasher.

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

Writes a single i32 into this hasher.

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

Writes a single i64 into this hasher.

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

Writes a single i128 into this hasher.

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

Writes a single isize into this hasher.

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

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

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

Advances the iterator and returns the next value. Read more

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

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

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

Returns the nth element of the iterator. Read more

pub fn last(self) -> Option<<I as Iterator>::Item>[src]

Consumes the iterator, returning the last element. Read more

fn count(self) -> usize[src]

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

fn advance_by(&mut self, n: usize) -> Result<(), usize>[src]

🔬 This is a nightly-only experimental API. (iter_advance_by #77404)

recently added

Advances the iterator by n elements. Read more

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

Notable traits for StepBy<I>

impl<I> Iterator for StepBy<I> where
    I: Iterator
type Item = <I as Iterator>::Item;
1.28.0[src]

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>

Notable traits for Chain<A, B>

impl<A, B> Iterator for Chain<A, B> where
    B: Iterator<Item = <A as Iterator>::Item>,
    A: Iterator
type Item = <A as Iterator>::Item;
where
    U: IntoIterator<Item = Self::Item>, 
[src]

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>

Notable traits for Zip<A, B>

impl<A, B> Iterator for Zip<A, B> where
    B: Iterator,
    A: Iterator
type Item = (<A as Iterator>::Item, <B as Iterator>::Item);
where
    U: IntoIterator
[src]

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

fn intersperse(self, separator: Self::Item) -> Intersperse<Self>

Notable traits for Intersperse<I>

impl<I> Iterator for Intersperse<I> where
    I: Iterator,
    <I as Iterator>::Item: Clone
type Item = <I as Iterator>::Item;
where
    Self::Item: Clone
[src]

🔬 This is a nightly-only experimental API. (iter_intersperse #79524)

recently added

Creates a new iterator which places a copy of separator between adjacent items of the original iterator. Read more

fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>

Notable traits for IntersperseWith<I, G>

impl<I, G> Iterator for IntersperseWith<I, G> where
    I: Iterator,
    G: FnMut() -> <I as Iterator>::Item
type Item = <I as Iterator>::Item;
where
    G: FnMut() -> Self::Item
[src]

🔬 This is a nightly-only experimental API. (iter_intersperse #79524)

recently added

Creates a new iterator which places an item generated by separator between adjacent items of the original iterator. Read more

fn map<B, F>(self, f: F) -> Map<Self, F>

Notable 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;
where
    F: FnMut(Self::Item) -> B, 
[src]

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

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

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

fn filter<P>(self, predicate: P) -> Filter<Self, P>

Notable 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;
where
    P: FnMut(&Self::Item) -> bool
[src]

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>

Notable 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;
where
    F: FnMut(Self::Item) -> Option<B>, 
[src]

Creates an iterator that both filters and maps. Read more

fn enumerate(self) -> Enumerate<Self>

Notable traits for Enumerate<I>

impl<I> Iterator for Enumerate<I> where
    I: Iterator
type Item = (usize, <I as Iterator>::Item);
[src]

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

fn peekable(self) -> Peekable<Self>

Notable traits for Peekable<I>

impl<I> Iterator for Peekable<I> where
    I: Iterator
type Item = <I as Iterator>::Item;
[src]

Creates an iterator which can use the peek and peek_mut methods to look at the next element of the iterator without consuming it. See their documentation for more information. Read more

fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>

Notable 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;
where
    P: FnMut(&Self::Item) -> bool
[src]

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

fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>

Notable 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;
where
    P: FnMut(&Self::Item) -> bool
[src]

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

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>

Notable traits for MapWhile<I, P>

impl<B, I, P> Iterator for MapWhile<I, P> where
    I: Iterator,
    P: FnMut(<I as Iterator>::Item) -> Option<B>, 
type Item = B;
where
    P: FnMut(Self::Item) -> Option<B>, 
[src]

🔬 This is a nightly-only experimental API. (iter_map_while #68537)

recently added

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

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

Notable traits for Skip<I>

impl<I> Iterator for Skip<I> where
    I: Iterator
type Item = <I as Iterator>::Item;
[src]

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

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

Notable traits for Take<I>

impl<I> Iterator for Take<I> where
    I: Iterator
type Item = <I as Iterator>::Item;
[src]

Creates an iterator that yields the first n elements, or fewer if the underlying iterator ends sooner. Read more

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>

Notable 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;
where
    F: FnMut(&mut St, Self::Item) -> Option<B>, 
[src]

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

fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>

Notable 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;
where
    F: FnMut(Self::Item) -> U,
    U: IntoIterator
[src]

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

fn flatten(self) -> Flatten<Self>

Notable 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;
where
    Self::Item: IntoIterator
1.29.0[src]

Creates an iterator that flattens nested structure. Read more

fn fuse(self) -> Fuse<Self>

Notable traits for Fuse<I>

impl<I> Iterator for Fuse<I> where
    I: Iterator
type Item = <I as Iterator>::Item;
[src]

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

fn inspect<F>(self, f: F) -> Inspect<Self, F>

Notable 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;
where
    F: FnMut(&Self::Item), 
[src]

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

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

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
    F: FnMut(&Self::Item) -> bool,
    B: Default + Extend<Self::Item>, 
[src]

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

fn partition_in_place<'a, T, P>(self, predicate: P) -> usize where
    Self: DoubleEndedIterator<Item = &'a mut T>,
    T: 'a,
    P: FnMut(&T) -> bool
[src]

🔬 This is a nightly-only experimental API. (iter_partition_in_place #62543)

new API

Reorders the elements of this iterator in-place according to the given predicate, such that all those that return true precede all those that return false. Returns the number of true elements found. Read more

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

🔬 This is a nightly-only experimental API. (iter_is_partitioned #62544)

new API

Checks if the elements of this iterator are partitioned according to the given predicate, such that all those that return true precede all those that return false. 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>, 
1.27.0[src]

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

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]

Folds every element into an accumulator by applying an operation, returning the final result. Read more

fn reduce<F>(self, f: F) -> Option<Self::Item> where
    F: FnMut(Self::Item, Self::Item) -> Self::Item
1.51.0[src]

Reduces the elements to a single one, by repeatedly applying a reducing operation. 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>, 
1.30.0[src]

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

fn try_find<F, R>(
    &mut self,
    f: F
) -> Result<Option<Self::Item>, <R as Try>::Error> where
    F: FnMut(&Self::Item) -> R,
    R: Try<Ok = bool>, 
[src]

🔬 This is a nightly-only experimental API. (try_find #63178)

new API

Applies function to the elements of iterator and returns the first true result or the first error. 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
    Self: ExactSizeIterator + DoubleEndedIterator,
    P: FnMut(Self::Item) -> bool
[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
    F: FnMut(&Self::Item) -> B,
    B: Ord
1.6.0[src]

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

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

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

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

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

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

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

fn rev(self) -> Rev<Self>

Notable traits for Rev<I>

impl<I> Iterator for Rev<I> where
    I: DoubleEndedIterator
type Item = <I as Iterator>::Item;
where
    Self: DoubleEndedIterator
[src]

Reverses an iterator’s direction. Read more

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

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

fn copied<'a, T>(self) -> Copied<Self>

Notable traits for Copied<I>

impl<'a, I, T> Iterator for Copied<I> where
    T: 'a + Copy,
    I: Iterator<Item = &'a T>, 
type Item = T;
where
    Self: Iterator<Item = &'a T>,
    T: 'a + Copy
1.36.0[src]

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

fn cloned<'a, T>(self) -> Cloned<Self>

Notable traits for Cloned<I>

impl<'a, I, T> Iterator for Cloned<I> where
    T: 'a + Clone,
    I: Iterator<Item = &'a T>, 
type Item = T;
where
    Self: Iterator<Item = &'a T>,
    T: 'a + Clone
[src]

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

fn cycle(self) -> Cycle<Self>

Notable traits for Cycle<I>

impl<I> Iterator for Cycle<I> where
    I: Clone + Iterator
type Item = <I as Iterator>::Item;
where
    Self: Clone
[src]

Repeats an iterator endlessly. Read more

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

Sums the elements of an iterator. Read more

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

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

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

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

fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Ordering,
    I: IntoIterator
[src]

🔬 This is a nightly-only experimental API. (iter_order_by #64295)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more

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

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

fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering> where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> Option<Ordering>,
    I: IntoIterator
[src]

🔬 This is a nightly-only experimental API. (iter_order_by #64295)

Lexicographically compares the elements of this Iterator with those of another with respect to the specified comparison function. Read more

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

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

fn eq_by<I, F>(self, other: I, eq: F) -> bool where
    F: FnMut(Self::Item, <I as IntoIterator>::Item) -> bool,
    I: IntoIterator
[src]

🔬 This is a nightly-only experimental API. (iter_order_by #64295)

Determines if the elements of this Iterator are equal to those of another with respect to the specified equality function. Read more

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

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

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

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

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

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

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

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

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

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

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, A> Ord for Box<T, A> where
    T: Ord + ?Sized,
    A: Allocator
[src]

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

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

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

Compares and returns the maximum of two values. Read more

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

Compares and returns the minimum of two values. Read more

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

Restrict a value to a certain interval. Read more

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

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

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

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

This method tests for !=.

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

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

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

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

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

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

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

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

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

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

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

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

pub fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>[src]

Formats the value using the given formatter.

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

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

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

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize>[src]

Like read, except that it reads into a slice of buffers. Read more

fn is_read_vectored(&self) -> bool[src]

🔬 This is a nightly-only experimental API. (can_vector #69941)

Determines if this Reader has an efficient read_vectored implementation. Read more

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

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

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

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

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

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

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

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

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

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

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

fn bytes(self) -> Bytes<Self>

Notable traits for Bytes<R>

impl<R: Read> Iterator for Bytes<R> type Item = Result<u8>;
where
    Self: Sized
[src]

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

fn chain<R: Read>(self, next: R) -> Chain<Self, R>

Notable traits for Chain<T, U>

impl<T: Read, U: Read> Read for Chain<T, U>
where
    Self: Sized
[src]

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

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

Notable traits for Take<T>

impl<T: Read> Read for Take<T>
where
    Self: Sized
[src]

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

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

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

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

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

🔬 This is a nightly-only experimental API. (seek_rewind #85149)

Rewind to the beginning of a stream. Read more

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

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

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

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

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

impl<S> Stream for Box<S, Global> where
    S: Stream + Unpin + ?Sized
[src]

type Item = <S as Stream>::Item

🔬 This is a nightly-only experimental API. (async_stream #79024)

The type of items yielded by the stream.

pub fn poll_next(
    self: Pin<&mut Box<S, Global>>,
    cx: &mut Context<'_>
) -> Poll<Option<<Box<S, Global> as Stream>::Item>>
[src]

🔬 This is a nightly-only experimental API. (async_stream #79024)

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more

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

🔬 This is a nightly-only experimental API. (async_stream #79024)

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

impl<T, const N: usize> TryFrom<Box<[T], Global>> for Box<[T; N], Global>1.43.0[src]

type Error = Box<[T], Global>

The type returned in the event of a conversion error.

pub fn try_from(
    boxed_slice: Box<[T], Global>
) -> Result<Box<[T; N], Global>, <Box<[T; N], Global> as TryFrom<Box<[T], Global>>>::Error>
[src]

Performs the conversion.

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

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

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

fn write_vectored(&mut self, bufs: &[IoSlice<'_>]) -> Result<usize>[src]

Like write, except that it writes from a slice of buffers. Read more

fn is_write_vectored(&self) -> bool[src]

🔬 This is a nightly-only experimental API. (can_vector #69941)

Determines if this Writer has an efficient write_vectored implementation. Read more

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

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

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

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

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

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

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<()>[src]

🔬 This is a nightly-only experimental API. (write_all_vectored #70436)

Attempts to write multiple buffers into this writer. Read more

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

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

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

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

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

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

impl<T, A> Unpin for Box<T, A> where
    T: ?Sized,
    A: Allocator + 'static, 
1.33.0[src]

Auto Trait Implementations

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

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

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

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

Blanket Implementations

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

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

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

pub fn from(t: !) -> T[src]

Performs the conversion.

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

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

Performs the conversion.

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

pub fn into(self) -> U[src]

Performs the conversion.

impl<F> IntoFuture for F where
    F: Future
[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future #67644)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future #67644)

Which kind of future are we turning this into?

pub fn into_future(self) -> <F as IntoFuture>::Future[src]

🔬 This is a nightly-only experimental API. (into_future #67644)

Creates a future from a value.

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?

pub fn into_iter(self) -> I[src]

Creates an iterator from a value. Read more

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

pub fn into_searcher(self, haystack: &'a str) -> CharPredicateSearcher<'a, F>[src]

🔬 This is a nightly-only experimental API. (pattern #27721)

API not fully fleshed out and ready to be stabilized

Constructs the associated searcher from self and the haystack to search in. Read more

pub fn is_contained_in(self, haystack: &'a str) -> bool[src]

🔬 This is a nightly-only experimental API. (pattern #27721)

API not fully fleshed out and ready to be stabilized

Checks whether the pattern matches anywhere in the haystack

pub fn is_prefix_of(self, haystack: &'a str) -> bool[src]

🔬 This is a nightly-only experimental API. (pattern #27721)

API not fully fleshed out and ready to be stabilized

Checks whether the pattern matches at the front of the haystack

pub fn strip_prefix_of(self, haystack: &'a str) -> Option<&'a str>[src]

🔬 This is a nightly-only experimental API. (pattern #27721)

API not fully fleshed out and ready to be stabilized

Removes the pattern from the front of haystack, if it matches.

pub fn is_suffix_of(self, haystack: &'a str) -> bool where
    CharPredicateSearcher<'a, F>: ReverseSearcher<'a>, 
[src]

🔬 This is a nightly-only experimental API. (pattern #27721)

API not fully fleshed out and ready to be stabilized

Checks whether the pattern matches at the back of the haystack

pub fn strip_suffix_of(self, haystack: &'a str) -> Option<&'a str> where
    CharPredicateSearcher<'a, F>: ReverseSearcher<'a>, 
[src]

🔬 This is a nightly-only experimental API. (pattern #27721)

API not fully fleshed out and ready to be stabilized

Removes the pattern from the back of haystack, if it matches.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T[src]

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)[src]

🔬 This is a nightly-only experimental API. (toowned_clone_into #41263)

recently added

Uses borrowed data to replace owned data, usually by cloning. Read more

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

pub default fn to_string(&self) -> String[src]

Converts the given value to a String. Read more

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.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

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.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.