Struct nom::lib::std::boxed::Box

[+] Show declaration

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

[−] Expand description

A pointer type for heap allocation.

See the module-level documentation for more.

Implementations

impl<T> Box<T>[−]

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

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

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

Examples

let five = Box::new(5);

pub fn new_uninit() -> Box<MaybeUninit<T>>[−]

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

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)

pub fn new_zeroed() -> Box<MaybeUninit<T>>[−]

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

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)

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

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

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

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

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

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

impl<T> Box<[T]>[−]

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

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

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

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

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

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

impl<T> Box<MaybeUninit<T>>[−]

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

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

Converts to Box<T>.

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)

impl<T> Box<[MaybeUninit<T>]>[−]

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

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

Converts to Box<[T]>.

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

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

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

Constructs a box from a raw pointer.

After calling this function, the raw pointer is owned by the resulting Box. Specifically, the Box destructor will call the destructor of T and free the allocated memory. For this to be safe, the memory must have been allocated in accordance with the memory layout used by Box .

Safety

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

Examples

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

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

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

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

unsafe {
    let ptr = alloc(Layout::new::<i32>()) as *mut i32;
    // 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);
}

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

Consumes the Box, returning a wrapped raw pointer.

The pointer will be properly aligned and non-null.

After calling this function, the caller is responsible for the memory previously managed by the Box. In particular, the caller should properly destroy T and release the memory, taking into account the memory layout used by Box. The easiest way to do this is to convert the raw pointer back into a Box with the Box::from_raw function, allowing the Box destructor to perform the cleanup.

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

Examples

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

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

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

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

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

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

Consumes and leaks the Box, returning a mutable reference, &'a mut T. Note that the type T must outlive the chosen lifetime 'a. If the type has only static references, or none at all, then this may be chosen to be 'static.

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

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

Examples

Simple usage:

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

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

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

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

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

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

This is also available via From.

impl Box<dyn Any + 'static>[−]

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

Attempt to downcast the box to a concrete type.

Examples

use std::any::Any;

fn print_if_string(value: Box<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));

impl Box<dyn Any + 'static + Send>[−]

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

Attempt to downcast the box to a concrete type.

Examples

use std::any::Any;

fn print_if_string(value: Box<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));

Trait Implementations

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Immutably borrows from an owned value.

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

[+] Show hidden undocumented items

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

Mutably borrows from an owned value.

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

[+] Show hidden undocumented items

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

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

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

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

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

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

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

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

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

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

fn lines(self) -> Lines<Self>[−]

Returns an iterator over the lines of this reader.

impl Clone for Box<OsStr>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Box<OsStr>[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Clone for Box<CStr>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Box<CStr>[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Clone for Box<Path>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Box<Path>[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Clone for Box<str>[+]

[+] Show hidden undocumented items

fn clone(&self) -> Box<str>[−]

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

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

Examples

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

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

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

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

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

Examples

let x = Box::new(5);
let mut y = Box::new(10);
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);

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

[+] Show hidden undocumented items

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for Box<OsStr>[+]

[+] Show hidden undocumented items

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

Returns the "default value" for a type.

impl Default for Box<CStr>[+]

[+] Show hidden undocumented items

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

Returns the "default value" for a type.

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

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

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

impl Default for Box<str>[+]

[+] Show hidden undocumented items

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

Returns the "default value" for a type.

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

[+] Show hidden undocumented items

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

Returns the "default value" for a type.

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

[+] Show hidden undocumented items

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

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

[+] Show hidden undocumented items

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

Mutably dereferences the value.

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

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

[+] Show hidden undocumented items

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

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

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

Returns the nth element from the end of the iterator.

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

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

recently added

Advances the iterator from the back by n elements.

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

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

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

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

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

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

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

[+] Show hidden undocumented items

fn drop(&mut self)[−]

Executes the destructor for this type.

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

impl<T> Error for Box<T> where
    T: Error, [+]

[+] Show hidden undocumented items

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

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

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

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

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

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

[+] Show hidden undocumented items

fn len(&self) -> usize[−]

Returns the exact length of the iterator.

fn is_empty(&self) -> bool[−]

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

Returns true if the iterator is empty.

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

[+] Show hidden undocumented items

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

Extends a collection with the contents of an iterator.

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

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

Extends a collection with exactly one element.

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

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

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

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

[+] Show hidden undocumented items

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

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

Performs the call operation.

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

[+] Show hidden undocumented items

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

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

Performs the call operation.

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

[+] Show hidden undocumented items

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

The returned type after the call operator is used.

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

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

Performs the call operation.

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

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

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

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

Examples

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

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

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

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

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

Examples

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

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

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

fn from(err: &str) -> Box<dyn Error + 'static>[−]

Converts a str into a box of dyn Error.

Examples

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

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

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

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

Converts a &str into a Box<str>

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

Examples

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

impl<T, const N: usize> From<[T; N]> for Box<[T]>[+]

fn from(array: [T; N]) -> Box<[T]>[−]

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

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

[+] Show hidden undocumented items

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

Performs the conversion.

impl From<Box<CStr>> for CString[+]

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

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

impl From<Box<OsStr>> for OsString[+]

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

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

impl From<Box<Path>> for PathBuf[+]

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

Converts a Box<Path> into a PathBuf

This conversion does not allocate or copy memory.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

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

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

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

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

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

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

Examples

Basic usage:

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

assert_eq!("hello world", s3)

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

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

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

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

Examples

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

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

assert_eq!(boxed_slice, boxed_str);

impl From<CString> for Box<CStr>[+]

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

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

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

fn from(cow: Cow<'_, str>) -> Box<str>[−]

Performs the conversion.

impl<'a> From<Cow<'a, str>> for Box<dyn Error + 'static>[+]

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

Converts a Cow into a box of dyn Error.

Examples

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

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

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

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

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

Examples

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

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

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

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

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

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

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

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

impl From<OsString> for Box<OsStr>[+]

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

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

impl From<PathBuf> for Box<Path>[+]

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

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<dyn Error + 'static + Sync + Send>[+]

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

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

Examples

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

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

impl From<String> for Box<dyn Error + 'static>[+]

fn from(str_err: String) -> Box<dyn Error + 'static>[−]

Converts a String into a box of dyn Error.

Examples

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

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

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

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

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

Examples

Basic usage:

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

assert_eq!("hello world", s3)

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

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

Converts a generic type T into a Box<T>

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

Examples

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

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

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

[+] Show hidden undocumented items

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

Performs the conversion.

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

[+] Show hidden undocumented items

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

Creates a value from an iterator.

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

[+] Show hidden undocumented items

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

Creates a value from an iterator.

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

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

[+] Show hidden undocumented items

type Output = <F as Future>::Output

The type of value produced on completion.

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

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

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

[+] Show hidden undocumented items

type Yield = <G as Generator<R>>::Yield

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

The type of value this generator yields.

type Return = <G as Generator<R>>::Return

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

The type of value this generator returns.

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

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

Resumes the execution of this generator.

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

[+] Show hidden undocumented items

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

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

[+] Show hidden undocumented items

fn finish(&self) -> u64[−]

Returns the hash value for the values written so far.

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

Writes some data into this Hasher.

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

Writes a single u8 into this hasher.

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

Writes a single u16 into this hasher.

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

Writes a single u32 into this hasher.

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

Writes a single u64 into this hasher.

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

Writes a single u128 into this hasher.

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

Writes a single usize into this hasher.

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

Writes a single i8 into this hasher.

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

Writes a single i16 into this hasher.

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

Writes a single i32 into this hasher.

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

Writes a single i64 into this hasher.

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

Writes a single i128 into this hasher.

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

Writes a single isize into this hasher.

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

[+] Show hidden undocumented items

type Item = <I as Iterator>::Item

The type of the elements being iterated over.

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

Advances the iterator and returns the next value.

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

Returns the bounds on the remaining length of the iterator.

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

Returns the nth element of the iterator.

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

Consumes the iterator, returning the last element.

fn count(self) -> usize[−]

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

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

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

recently added

Advances the iterator by n elements.

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

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

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

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

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

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

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

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

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

Calls a closure on each element of an iterator.

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

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

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

Creates an iterator that both filters and maps.

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

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

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

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

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

Creates an iterator that skips elements based on a predicate.

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

Creates an iterator that yields elements based on a predicate.

fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P> where
    P: FnMut(Self::Item) -> Option<B>, [−]

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

recently added

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

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

Creates an iterator that skips the first n elements.

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

Creates an iterator that yields its first n elements.

fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F> where
    F: FnMut(&mut St, Self::Item) -> Option<B>, [−]

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

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

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

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

Creates an iterator that flattens nested structure.

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

Creates an iterator which ends after the first None.

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

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

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

Borrows an iterator, rather than consuming it.

[+] Expand attributes

#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]fn collect<B>(self) -> B where
    B: FromIterator<Self::Item>, [−]

Transforms an iterator into a collection.

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

Consumes an iterator, creating two collections from it.

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

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

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.

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

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

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.

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

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

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

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

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

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

fn fold_first<F>(self, f: F) -> Option<Self::Item> where
    F: FnMut(Self::Item, Self::Item) -> Self::Item, [−]

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

The same as fold(), but uses the first element in the iterator as the initial value, folding every subsequent element into it. If the iterator is empty, return None; otherwise, return the result of the fold.

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

Tests if every element of the iterator matches a predicate.

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

Tests if any element of the iterator matches a predicate.

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

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

fn find_map<B, F>(&mut self, f: F) -> Option<B> where
    F: FnMut(Self::Item) -> Option<B>, [−]

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

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

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

new API

Applies function to the elements of iterator and returns the first true result or the first error.

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

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

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

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

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

Returns the maximum element of an iterator.

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

Returns the minimum element of an iterator.

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

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

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

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

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

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

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

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

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

Reverses an iterator's direction.

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

Converts an iterator of pairs into a pair of containers.

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

Creates an iterator which copies all of its elements.

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

Creates an iterator which clones all of its elements.

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

Repeats an iterator endlessly.

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

Sums the elements of an iterator.

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

Iterates over the entire iterator, multiplying all the elements

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

new API

Checks if the elements of this iterator are sorted.

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

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

new API

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

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

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

new API

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

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

[+] Show hidden undocumented items

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

This method returns an Ordering between self and other.

[+] Expand attributes

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

Compares and returns the maximum of two values.

[+] Expand attributes

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

Compares and returns the minimum of two values.

[+] Expand attributes

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

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

Restrict a value to a certain interval.

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

[+] Show hidden undocumented items

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

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

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

This method tests for !=.

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

[+] Show hidden undocumented items

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

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

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

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

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

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

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

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

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

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

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

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

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

[+] Show hidden undocumented items

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

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

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

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

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

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

Determines if this Reader has an efficient read_vectored implementation.

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

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

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

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

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

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

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

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

Read the exact number of bytes required to fill buf.

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

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

fn bytes(self) -> Bytes<Self>[−]

Transforms this Read instance to an Iterator over its bytes.

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

Creates an adaptor which will chain this stream with another.

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

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

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

[+] Show hidden undocumented items

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

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

fn stream_len(&mut self) -> Result<u64, Error>[−]

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

Returns the length of this stream (in bytes).

fn stream_position(&mut self) -> Result<u64, Error>[−]

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

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

impl<T, const N: usize> TryFrom<Box<[T]>> for Box<[T; N]>[+]

[+] Show hidden undocumented items

type Error = Box<[T]>

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

[+] Show hidden undocumented items

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

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

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

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

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

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

Determines if this Writeer has an efficient write_vectored implementation.

fn flush(&mut self) -> Result<(), Error>[−]

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

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

Attempts to write an entire buffer into this writer.

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

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

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

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

Attempts to write multiple buffers into this writer.

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

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