Skip to main content

Userdata

Struct Userdata 

Source
pub struct Userdata { /* private fields */ }
Expand description

A Lua userdata object — a GC-managed handle wrapping a host-side payload (an io file handle, a newproxy identity token, or an embedder-supplied Rust value) plus an optional metatable.

Implementations§

Source§

impl Userdata

Source

pub fn metatable(&self) -> Option<Gc<Table>>

This userdata’s metatable, if one is attached.

Source

pub fn set_metatable(&mut self, mt: Option<Gc<Table>>)

Install (or clear) this userdata’s metatable.

Source

pub fn file(&self) -> &FileHandle

The file handle behind this userdata (all io userdata are files; the Empty proxy variant is only constructed by newproxy and surfaces via Self::is_proxy, so callers reaching .file() must already know they hold a file handle — luna’s io builtins all guard with is_proxy() or Userdata matching before unpacking).

Source

pub fn file_mut(&mut self) -> &mut FileHandle

Mutable variant of Self::file.

Source

pub fn is_proxy(&self) -> bool

True for newproxy userdata — they have no host payload, only a metatable and identity. io builtins reject these with the PUC “bad argument” error rather than panicking on file().

Source

pub fn is_host(&self) -> bool

True for B8 host userdata (embedder-supplied T: 'static).

Source

pub fn downcast<T: Any + 'static>(&self) -> Option<&T>

Borrow the host payload as &T if this userdata holds a T. Returns None when the userdata isn’t a host payload, or holds a different T. Embedders typically reach this through crate::vm::Vm::userdata_borrow or via a Value::Userdata match arm.

Source

pub fn downcast_mut<T: Any + 'static>(&mut self) -> Option<&mut T>

Mutable borrow variant of Self::downcast.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.