Struct ItemRef 

pub struct ItemRef { /* private fields */ }

A reference to a Lua value.

When running .execute or .store on a ItemRef.
The global lua variable: self will be the referenced value this links to.

Can also be used as an argument to a Script with arg_ref or named_arg_ref.

Implementations

impl ItemRef

pub unsafe fn new(resolve: Resolve, id: u64) -> Self

Creates a new ItemRef with it’s lua module id and the Resolve instance it was retrieved from.

Safety

This is unsafe since if you were to mismatch the id and which Resolve instance it was gathered from then it would be undefined behavior. Only ever use this if you know for a fact that the id you pass it derives from the same Resolve instance and hasn’t already been dropped in the module.

pub fn id(&self) -> u64

Returns the unique id for this reference

pub async fn execute<'c, T>( &'c self, script: impl Into<Script<'c>>, ) -> Result<T, Error>

where T: DeserializeOwned,

Execute some lua code, setting self to the stored reference value and returning what the code returned.

Look at Resolve::execute for more info on how it works.

Errors

If the module executing the code fails or if the script can’t be sent

pub async fn store<'c>( &'c self, script: impl Into<Script<'c>>, ) -> Result<ItemRef, Error>

Store a reference to Lua value in Rust, global variable self is set to the value stored in the ItemRef.

Look at Resolve::store for more info on how it works.

Errors

If the module executing the code fails, if the script can’t be sent or if the returned value is nil

pub async fn store_option<'c>( &'c self, script: impl Into<Script<'c>>, ) -> Result<Option<ItemRef>, Error>

Maybe stores a reference to Lua value in Rust, global variable self is set to the value stored in the ItemRef.

If the returned value is nil, this will return None.

Look at store for more info.

Errors

If the module executing the code fails or if the script can’t be sent

pub async fn store_list<'c>( &'c self, script: impl Into<Script<'c>>, ) -> Result<ItemRefList, Error>

Store multiple references to Lua values in Rust,

Look at Resolve::store_list for more info on how it works.

Errors

If the module executing the code fails or if the script can’t be sent.
Or if the returned value from lua was not a table

pub async fn value<T>(&self) -> Result<T, Error>

where T: DeserializeOwned,

Returns the referenced value directly.

Reference is still valid, this just clones the value.

Errors

If the module executing the code fails or if the script can’t be sent

pub async unsafe fn manual_drop(resolve: Resolve, id: u64)

Sends a packet to the lua module to drop the reference in the lua context.
This can be used to ensure a reference is dropped before doing anything else.
Aka, this is blocking if you .await it since the normal Drop can finish anytime it wants in the background.

Safety

You must ensure that the id came from correct Resolve instance and that the value hasn’t already been dropped

Error

This will silently fail and print its err to stderr if it fails.

Trait Implementations

impl Clone for ItemRef

fn clone(&self) -> ItemRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ItemRef

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

Formats the value using the given formatter.

impl Display for ItemRef

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

Formats the value using the given formatter.

impl Eq for ItemRef

impl Hash for ItemRef

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for ItemRef

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

Equality operator ==.

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

Inequality operator !=.

impl ResolveExecute for ItemRef

fn execute<'c, T: DeserializeOwned + Send>( &'c self, script: impl Into<Script<'c>> + Send, ) -> impl Future<Output = Result<T, Error>> + Send

impl ResolveStore for ItemRef

fn store<'c>( &'c self, script: impl Into<Script<'c>> + Send, ) -> impl Future<Output = Result<ItemRef, Error>> + Send

fn store_option<'c>( &'c self, script: impl Into<Script<'c>> + Send, ) -> impl Future<Output = Result<Option<ItemRef>, Error>> + Send

fn store_list<'c>( &'c self, script: impl Into<Script<'c>> + Send, ) -> impl Future<Output = Result<ItemRefList, Error>> + Send