InplaceBox

Struct InplaceBox

pub struct InplaceBox<T: ?Sized, const SIZE: usize> { /* private fields */ }

Expand description

A container similar to Box, but without heap allocation.

It stores data inline within a fixed-size buffer.

Implementations§

impl<T: ?Sized, const SIZE: usize> InplaceBox<T, SIZE>

pub fn new<'a, U: Sized + Unsize<T> + 'a>(value: U) -> Self

Construct a new object in-place in this object.

The type of the value must be convertible to dyn T and its size and alignment less than or equal to that of the InplaceBox space for the object.

Type match, size and alignment are checked statically by the compiler.

impl<T: ?Sized, const SIZE: usize> InplaceBox<T, SIZE>

pub unsafe fn new_unchecked<'a, U: Sized + Unsize<T> + 'a>(value: U) -> Self

Construct a new object in-place in this object, without checking the size.

The type of the value must be convertible to dyn T.

This constructor is provided to allow constructing objects either in InplaceBox of a certain size or on heap for larger sizes. Since if conditions in the caller on the object size are not optimized out in debug mode, the code wouldn’t compile when statically checking the size. With unchecked version, it’s possible to have such dynamically-switched generics.

§Safety

The caller needs to ensure that the size of the type U is less than or equal to the SIZE of the InplaceBox. Only the type match and alignment is checked statically by the compiler.

Prefer to use the safe Self::new constructor which checks for the size.

Trait Implementations§

impl<T: ?Sized, const SIZE: usize> AsMut<T> for InplaceBox<T, SIZE>

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

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T: ?Sized, const SIZE: usize> AsRef<T> for InplaceBox<T, SIZE>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T: ?Sized, const SIZE: usize> Borrow<T> for InplaceBox<T, SIZE>

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T: ?Sized, const SIZE: usize> BorrowMut<T> for InplaceBox<T, SIZE>

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

Mutably borrows from an owned value. Read more

impl<T: ?Sized + Debug, const SIZE: usize> Debug for InplaceBox<T, SIZE>

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

Formats the value using the given formatter. Read more

impl<T: ?Sized, const SIZE: usize> Deref for InplaceBox<T, SIZE>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: ?Sized, const SIZE: usize> DerefMut for InplaceBox<T, SIZE>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T: ?Sized + Display, const SIZE: usize> Display for InplaceBox<T, SIZE>

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

Formats the value using the given formatter. Read more

impl<T: ?Sized, const SIZE: usize> Drop for InplaceBox<T, SIZE>

fn drop(&mut self)

Executes the destructor for this type. Read more

impl<Args: Tuple, F: Fn<Args> + ?Sized, const SIZE: usize> Fn<Args> for InplaceBox<F, SIZE>

extern "rust-call" fn call(&self, args: Args) -> Self::Output

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

Performs the call operation.

impl<Args: Tuple, F: FnMut<Args> + ?Sized, const SIZE: usize> FnMut<Args> for InplaceBox<F, SIZE>

extern "rust-call" fn call_mut(&mut self, args: Args) -> Self::Output

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

Performs the call operation.

impl<Args: Tuple, F: FnOnce<Args> + ?Sized, const SIZE: usize> FnOnce<Args> for InplaceBox<F, SIZE>

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

The returned type after the call operator is used.

extern "rust-call" fn call_once(self, args: Args) -> Self::Output

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

Performs the call operation.

impl<T: ?Sized + Future, const SIZE: usize> Future for InplaceBox<T, SIZE>

type Output = <T as Future>::Output

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

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

impl<T: ?Sized, const SIZE: usize> Pointer for InplaceBox<T, SIZE>

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl<T, const SIZE: usize> Freeze for InplaceBox<T, SIZE>
where T: ?Sized,

impl<T, const SIZE: usize> RefUnwindSafe for InplaceBox<T, SIZE>
where T: RefUnwindSafe + ?Sized,

impl<T, const SIZE: usize> Send for InplaceBox<T, SIZE>
where T: Send + ?Sized,

impl<T, const SIZE: usize> Sync for InplaceBox<T, SIZE>
where T: Sync + ?Sized,

impl<T, const SIZE: usize> Unpin for InplaceBox<T, SIZE>
where T: Unpin + ?Sized,

impl<T, const SIZE: usize> UnwindSafe for InplaceBox<T, SIZE>
where T: UnwindSafe + ?Sized,

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<F> IntoFuture for F
where F: Future,

type Output = <F as Future>::Output

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more

impl<F> Pattern for F
where F: FnMut(char) -> bool,

type Searcher<'a> = CharPredicateSearcher<'a, F>

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

Associated searcher for this pattern

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

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

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

fn is_contained_in<'a>(self, haystack: &'a str) -> bool

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

Checks whether the pattern matches anywhere in the haystack

fn is_prefix_of<'a>(self, haystack: &'a str) -> bool

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

Checks whether the pattern matches at the front of the haystack

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

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

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

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

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

Checks whether the pattern matches at the back of the haystack

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

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

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

fn as_utf8_pattern(&self) -> Option<Utf8Pattern<'_>>

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

Returns the pattern as utf-8 bytes if possible.

impl<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

type Target = T

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

The target type on which the method may be called.

impl<T> ToString for T
where T: Display + ?Sized,

fn to_string(&self) -> String

Converts the given value to a String. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

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

Performs the conversion.