Struct Val 

#[repr(transparent)]
pub struct Val<T>(pub T);

A wrapper type that makes a registered type safe to pass to and from Roto.

Only types that implement the sealed Value trait can be passed to Roto. Some primitive types implement this trait directly, but every other type needs to be wrapped in Val. You should not wrap the primitives in Val.

This type implements Deref and DerefMut to allow for easy access to the inner value.

#[derive(Clone)]
struct Foo {
    a: i32,
    b: i32,
}

let rt = Runtime::from_lib(library! {
    #[clone] type Foo = Val<Foo>;
}).unwrap();

// compile a script...

// Pass Foo to Roto wrapped in Val:
let f = pkg.get_function::<fn(Val<Foo>) -> ()>("main").unwrap();
f.call(Val(Foo { a: 1, b: 2 }));

// For Option and Verdict, wrap the inner type in Val
pkg.get_function::<fn(Option<Val<Foo>>) -> ()>("main").unwrap();

// Do not wrap types that already implement Value.
pkg.get_function::<fn(i32) -> ()>("main").unwrap();

Tuple Fields

0: T

Trait Implementations

impl<T: Clone> Clone for Val<T>

fn clone(&self) -> Val<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Val<T>

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

Formats the value using the given formatter.

impl<T> Deref for Val<T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Val<T>

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

Mutably dereferences the value.

impl<T> From<T> for Val<T>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<T: Ord> Ord for Val<T>

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<T: PartialEq> PartialEq for Val<T>

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: PartialOrd> PartialOrd for Val<T>

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

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

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

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

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

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

impl<T: 'static + Clone + PartialEq + Send + Sync> Value for Val<T>

type Transformed = Val<T>

Intermediate type that can be used to convert a type to a Roto type

type AsParam = *mut T

The type that this type should be converted into when passed to Roto

fn transform(self) -> Self::Transformed

Transform this value into a value that Roto understands

fn untransform(transformed: Self::Transformed) -> Self

Transform this a Roto value back into this type

fn resolve() -> Ty

Put information about this type into the global type registry

fn name() -> &'static str

Return the name of this type.

fn as_param(transformed: &mut Self::Transformed) -> Self::AsParam

Turn the transformed value into a proper Roto function parameter.

fn to_value(param: Self::AsParam) -> Self::Transformed

Turn a Roto function parameter into a transformed value.

fn from_ir_value( mem: &mut Memory, value: IrValue, ) -> Result<Self::AsParam, IrValueDoesNotMatchType>

Attempt to convert an IR value into Self

impl<T: Copy> Copy for Val<T>

impl<T: Eq> Eq for Val<T>

impl<T> StructuralPartialEq for Val<T>