Struct smallbox::StackBox

pub struct StackBox<T: ?Sized, Space = S2> { /* fields omitted */ }

On-stack allocation for dynamically-sized type.

Examples

use smallbox::StackBox;

let val: StackBox<PartialEq<usize>> = StackBox::new(5usize).unwrap();

assert!(*val == 5)

Methods

impl<T: ?Sized, Space> StackBox<T, Space>

fn new<U>(val: U) -> Result<StackBox<T, Space>, U> where
    U: Unsize<T>, 

Try to alloc on stack, and return Err when val is larger than capacity

Examples

use smallbox::StackBox;

assert!(StackBox::<[usize]>::new([0usize; 1]).is_ok());
assert!(StackBox::<[usize]>::new([0usize; 8]).is_err());

fn resize<ToSpace>(self) -> Result<StackBox<T, ToSpace>, Self>

Try to transforms to a StackBox<T> with bigger capacity, and return Err when target capacity is smaller.

Example

use smallbox::StackBox;
use smallbox::space::*;

let s = StackBox::<[usize], S8>::new([0usize; 4]).unwrap();
assert!(s.resize::<S16>().is_ok());

let s = StackBox::<[usize], S8>::new([0usize; 4]).unwrap();
assert!(s.resize::<S4>().is_err());

Trait Implementations

impl<T: ?Sized, Space> Deref for StackBox<T, Space>

type Target = T

The resulting type after dereferencing

fn deref(&self) -> &T

The method called to dereference a value

impl<T: ?Sized, Space> DerefMut for StackBox<T, Space>

fn deref_mut(&mut self) -> &mut T

The method called to mutably dereference a value

impl<T: ?Sized, Space> Drop for StackBox<T, Space>

fn drop(&mut self)

A method called when the value goes out of scope.

impl<T: Display + ?Sized, Space> Display for StackBox<T, Space>

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

Formats the value using the given formatter.

impl<T: Debug + ?Sized, Space> Debug for StackBox<T, Space>

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

Formats the value using the given formatter.

impl<T: ?Sized, Space> Pointer for StackBox<T, Space>

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

Formats the value using the given formatter.

impl<T: ?Sized + PartialEq, Space> PartialEq for StackBox<T, Space>

fn eq(&self, other: &StackBox<T, Space>) -> bool

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

fn ne(&self, other: &StackBox<T, Space>) -> bool

This method tests for !=.

impl<T: ?Sized + PartialOrd, Space> PartialOrd for StackBox<T, Space>

fn partial_cmp(&self, other: &StackBox<T, Space>) -> Option<Ordering>

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

fn lt(&self, other: &StackBox<T, Space>) -> bool

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

fn le(&self, other: &StackBox<T, Space>) -> bool

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

fn ge(&self, other: &StackBox<T, Space>) -> bool

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

fn gt(&self, other: &StackBox<T, Space>) -> bool

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

impl<T: ?Sized + Ord, Space> Ord for StackBox<T, Space>

fn cmp(&self, other: &StackBox<T, Space>) -> Ordering

This method returns an Ordering between self and other.

impl<T: ?Sized + Eq, Space> Eq for StackBox<T, Space>

impl<T: ?Sized + Hash, Space> Hash for StackBox<T, Space>

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

Feeds this value into the given [Hasher].

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

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