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

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

A pointer type for heap allocation.

See the module-level documentation for more.

Methods

impl<T> Box<T>
[src]

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

Examples

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

impl<T> Box<T> where T: ?Sized
[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. Since the way Box allocates and releases memory is unspecified, the only valid pointer to pass to this function is the one taken from another Box via the Box::into_raw function.

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

Examples

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

Consumes the Box, returning the wrapped raw pointer.

After calling this function, the caller is responsible for the memory previously managed by the Box. In particular, the caller should properly destroy T and release the memory. The proper way to do so is to convert the raw pointer back into a Box with the Box::from_raw function.

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

Examples

let x = Box::new(5);
let ptr = Box::into_raw(x);Run

impl Box<Any + 'static>
[src]

Attempt to downcast the box to a concrete type.

Examples

use std::any::Any;

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

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

impl Box<Any + 'static + Send>
[src]

Attempt to downcast the box to a concrete type.

Examples

use std::any::Any;

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

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

Trait Implementations

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

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

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

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

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

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

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

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

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

The resulting type after dereferencing

The method called to dereference a value

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

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

Feeds this value into the state given, updating the hasher as necessary.

Feeds a slice of this type into the state provided.

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

Mutably borrows from an owned value. Read more

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

Performs the conversion.

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

The method called to mutably dereference a value

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

Formats the value using the given formatter.

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

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

Returns the exact number of times the iterator will iterate. Read more

Unstable (exact_size_is_empty #35428)

Returns whether the iterator is empty. Read more

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

Unstable (placement_new_protocol #27779)

The kind of data that is stored in this kind of box.

Unstable (placement_new_protocol #27779)

The place that will negotiate the storage of the data.

Unstable (placement_new_protocol #27779)

Converts filled place into final owning value, shifting deallocation/cleanup responsibilities (if any remain), over to returned instance of Self and forgetting filled. Read more

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

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

Performs the conversion.

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

Formats the value using the given formatter.

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

Performs the conversion.

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

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

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

Returns the "default value" for a type. Read more

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

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

Examples

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

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

Examples

let x = Box::new(5);
let mut y = Box::new(10);

y.clone_from(&x);

assert_eq!(*y, 5);Run

impl Clone for Box<str>
1.3.0
[src]

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

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

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

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

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

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

The type of the elements being iterated over.

Advances the iterator and returns the next value. Read more

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

Returns the nth element of the iterator. Read more

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

Consumes the iterator, returning the last element. Read more

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

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

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

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

Creates an iterator that both filters and maps. Read more

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

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

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

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

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

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

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

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

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

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

Borrows an iterator, rather than consuming it. Read more

Transforms an iterator into a collection. Read more

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

An iterator adaptor that applies a function, producing a single, final value. Read more

Tests if every element of the iterator matches a predicate. Read more

Tests if any element of the iterator matches a predicate. Read more

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

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

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

Returns the maximum element of an iterator. Read more

Returns the minimum element of an iterator. Read more

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

Unstable (iter_max_by #36105)

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

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

Unstable (iter_min_by #36105)

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

Reverses an iterator's direction. Read more

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

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

Repeats an iterator endlessly. Read more

Sums the elements of an iterator. Read more

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

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

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

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

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

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

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

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

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

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

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

This method tests for !=.

impl<'a, A, R> FnOnce<A> for Box<FnBox<A, Output=R> + 'a>
[src]

The returned type after the call operator is used.

Unstable (fn_traits #29625)

This is called when the call operator is used.

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

The returned type after the call operator is used.

Unstable (fn_traits #29625)

This is called when the call operator is used.

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

Immutably borrows from an owned value. Read more

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

Formats the value using the given formatter.

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

Performs the conversion.

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

Performs the conversion.

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

Performs the conversion.

impl From<String> for Box<Error>
1.7.0
[src]

Performs the conversion.

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

Performs the conversion.

impl<'a> From<&'a str> for Box<Error>
1.7.0
[src]

Performs the conversion.

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

A short description of the error. Read more

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

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

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

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

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

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

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

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

Unstable (io #27802)

: the semantics of a partial read/write of where errors happen is currently unclear and may change

Transforms this Read instance to an Iterator over chars. Read more

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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