Struct UserData 

pub struct UserData<T, const OVERWRITE: bool = false, const VALUE: u64 = 0>(/* private fields */);

UserData is used to push user provided data to the sqvm for storage

UserDataRef can be used to access the data from functions calls

UserData handles dropping the data via a release hook in sqvm

Implementations

impl<const OVERWRITE: bool, const VALUE: u64, T: 'static> UserData<T, OVERWRITE, VALUE>

pub fn new(userdata: T) -> Self

Creates a new UserData<T>.

Example

// cannot be pushed to sqvm normally
struct HttpClient;

#[rrplug::sqfunction(VM = "SERVER | CLIENT | UI")]
fn build_client() -> UserData<HttpClient> {
    UserData::new(HttpClient)
}

pub const fn from_boxed(userdata: Box<T>) -> Self

Creates a new UserData<T> from boxed data

Trait Implementations

impl<const OVERWRITE: bool, const VALUE: u64, T: 'static> From<Box<T>> for UserData<T, OVERWRITE, VALUE>

fn from(value: Box<T>) -> Self

Converts to this type from the input type.

impl<const OVERWRITE: bool, const VALUE: u64, T: 'static> From<T> for UserData<T, OVERWRITE, VALUE>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<const OVERWRITE: bool, const VALUE: u64, T: 'static> PushToSquirrelVm for UserData<T, OVERWRITE, VALUE>

fn push_to_sqvm( self, sqvm: NonNull<HSquirrelVM>, sqfunctions: &SquirrelFunctions, )

pushes the value to the stack

impl<const OVERWRITE: bool, const VALUE: u64, T: 'static> SQVMName for UserData<T, OVERWRITE, VALUE>

fn get_sqvm_name() -> String

the name on the sqvm of a type