Struct OwnedArgument

pub struct OwnedArgument { /* private fields */ }

An owned argument.

This carries a generic item that implements both Any and Clone. In addition, depending on the storage itself, it is able to implement items whose size is no more than 8 bytes for 64-bit systems (or 4 for 32-bit systems).

Implementations

impl OwnedArgument

pub fn new<T>(item: T) -> Self

where T: Any + Clone,

Creates a new OwnedArgument based around a generic item.

If the size of said item is less than 8 bytes for 64-bit systems (4 for 32-bit systems), then the storage is inlined. Otherwise, the storage gets allocated instead.

pub fn is_type<T>(&self) -> bool

where T: Any + Clone,

A “wrapper” for Any::is::<T>().

In case Any interferes with dereferencing the OwnedArgument, use the following function instead.

pub fn downcast_owned<T>(self) -> Result<T, Self>

where T: Any + Clone,

Downcasts the object into an owned instance.

Return values:

Ok(val): The value matches is T, and the previous storage frees itself. Err(self): The value does not match T, the inner value should remain identical.

pub unsafe fn downcast_owned_unchecked<T>(self) -> T

where T: Any + Clone,

Downcasts the inner value into T without checking it first.

Safety

This assumes that the type supplied is, in fact, T.

pub fn downcast_cloned<T>(&self) -> Option<T>

where T: Any + Clone,

Downcasts a reference of the OwnedArgument before returning the cloned contents of the inner value:

Return values

Some(v): The cloned object is of type T, None: OwnedArgument is not type T

pub unsafe fn downcast_cloned_unchecked<T>(&self) -> T

where T: Any + Clone,

Returns the cloned contents of the inner type of an OwnedArgument without performing any checks.

Safety

This assumes that the OwnedArgument is type T.

Trait Implementations

impl Clone for OwnedArgument

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OwnedArgument

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

Formats the value using the given formatter.

impl Deref for OwnedArgument

type Target = dyn Any

The resulting type after dereferencing.

fn deref(&self) -> &dyn Any

Dereferences the value.

impl DerefMut for OwnedArgument

fn deref_mut(&mut self) -> &mut dyn Any

Mutably dereferences the value.

impl Drop for OwnedArgument

fn drop(&mut self)

Executes the destructor for this type.