Struct abi_stable::std_types::RBox

#[repr(C)]
pub struct RBox<T> { /* fields omitted */ }

Ffi-safe equivalent of Box<_>.

Example

Declaring a recursive datatype.

use abi_stable::{
    std_types::{RBox,RString},
    StableAbi,
};

#[repr(u8)]
#[derive(StableAbi)]
enum Command{
    SendProduct{
        id:u64,
    },
    GoProtest{
        cause:RString,
        place:RString,
    },
    SendComplaint{
        cause:RString,
        website:RString,
    },
    WithMetadata{
        command:RBox<Command>,
        metadata:RString,
    },
}

Methods

impl<T> RBox<T>

pub fn new(value: T) -> Self

Constucts an RBox<T> from a value.

Example

use abi_stable::std_types::RBox;

let baux=RBox::new(100);
assert_eq!(*baux,100);

pub fn from_box(p: Box<T>) -> RBox<T>

Converts a Box<T> to an RBox<T>,reusing its heap allocation.

Example

use abi_stable::std_types::RBox;

let baux=Box::new(200);
let baux=RBox::from_box(baux);
assert_eq!(*baux,200);

pub fn from_move_ptr(p: MovePtr<T>) -> RBox<T>

Constructs a Box<T> from a MovePtr<'_,T>.

Example

use std::mem::ManuallyDrop;
 
use abi_stable::{
    pointer_trait::OwnedPointer,
    sabi_types::RSmallBox,
    std_types::RBox,
};

let b=RSmallBox::<_,[u8;1]>::new(77u8);
let rbox:RBox<_>=b.in_move_ptr(|x| RBox::from_move_ptr(x) );
 
assert_eq!(*rbox,77);

impl<T> RBox<T>

pub fn into_box(this: Self) -> Box<T>

Converts this RBox<T> into a Box<T>

Allocation

If this is invoked outside of the dynamic library/binary that created the RBox<T>, it will allocate a new Box<T> and move the data into it.

Example

use abi_stable::std_types::RBox;

let baux:RBox<u32>=RBox::new(200);
let baux:Box<u32>=RBox::into_box(baux);
assert_eq!(*baux,200);

pub fn into_inner(this: Self) -> T

Unwraps this Box<T> into the value it owns on the heap.

Example

use abi_stable::std_types::RBox;

let baux:RBox<u32>=RBox::new(200);
let baux:u32=RBox::into_inner(baux);
assert_eq!(baux,200);

Trait Implementations

impl<T> IntoReprRust for RBox<T>

type ReprRust = Box<T>

fn into_rust(self) -> Self::ReprRust

impl<T> GetStaticEquivalent_ for RBox<T> where
    T: __StableAbi, 

type StaticEquivalent = _static_RBox<__GetStaticEquivalent<T>>

impl<T> SharedStableAbi for RBox<T> where
    T: __StableAbi, 

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

type Kind = __ValueKind

The kind of abi stability of this type,there are 2:

const S_LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

const S_ABI_CONSTS: AbiConsts

impl<T> GetPointerKind for RBox<T>

type Kind = PK_SmartPointer

const KIND: PointerKind

impl<T, O> CanTransmuteElement<O> for RBox<T>

type TransmutedPtr = RBox<O>

The type of the pointer after it's element type has been changed.

impl<T> OwnedPointer for RBox<T>

unsafe fn get_move_ptr(this: &mut ManuallyDrop<Self>) -> MovePtr<Self::Target>

Gets a move pointer to the contents of this pointer.

unsafe fn drop_allocation(this: &mut ManuallyDrop<Self>)

Deallocates the pointer without dropping its owned contents.

fn with_move_ptr<F, R>(this: ManuallyDrop<Self>, f: F) -> R where
    F: FnOnce(MovePtr<Self::Target>) -> R,
    Self::Target: Sized, 

fn in_move_ptr<F, R>(self, f: F) -> R where
    F: FnOnce(MovePtr<Self::Target>) -> R,
    Self::Target: Sized, 

impl<T: Send> Send for RBox<T>

impl<T: Sync> Sync for RBox<T>

impl<T> Drop for RBox<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> AsRef<T> for RBox<T>

fn as_ref(&self) -> &T

Performs the conversion.

impl<T> AsMut<T> for RBox<T>

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

Performs the conversion.

impl<T, Inline> Into<RBox<T>> for RSmallBox<T, Inline> where
    Inline: InlineStorage, 

Converts a RSmallBox into an RBox,currently this allocates.

fn into(self) -> RBox<T>

Performs the conversion.

impl<T> From<Box<T>> for RBox<T>

fn from(this: Box<T>) -> RBox<T>

Performs the conversion.

impl<T, Inline> From<RBox<T>> for RSmallBox<T, Inline> where
    Inline: InlineStorage, 

Converts an RBox into an RSmallBox,currently this allocates.

fn from(this: RBox<T>) -> Self

Performs the conversion.

impl<T> Clone for RBox<T> where
    T: Clone, 

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Default for RBox<T> where
    T: Default, 

fn default() -> Self

Returns the "default value" for a type.

impl<T> Eq for RBox<T> where
    T: Eq, 

impl<T> Ord for RBox<T> where
    T: Ord, 

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

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<RBox<T>> for RBox<T> where
    T: PartialEq, 

fn eq(&self, other: &Self) -> bool

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<T> PartialOrd<RBox<T>> for RBox<T> where
    T: PartialOrd, 

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl<T> Display for RBox<T> where
    T: Display, 

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

Formats the value using the given formatter.

impl<T> Debug for RBox<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Deref for RBox<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for RBox<T>

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

Mutably dereferences the value.

impl<T> Hash for RBox<T> where
    T: Hash, 

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> Borrow<T> for RBox<T>

fn borrow(&self) -> &T

Immutably borrows from an owned value.

impl<T> BorrowMut<T> for RBox<T>

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

Mutably borrows from an owned value.

impl<'de, T> Deserialize<'de> for RBox<T> where
    T: Deserialize<'de>, 

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for RBox<T> where
    T: Serialize, 

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.