Enum MetaMethod 

#[non_exhaustive]
pub enum MetaMethod {
    Add,
    Sub,
    Mul,
    Div,
    Mod,
    Pow,
    IDiv,
    BAnd,
    BOr,
    BXor,
    Shl,
    Shr,
    BNot,
    Unm,
    Concat,
    Len,
    Eq,
    Lt,
    Le,
    Index,
    NewIndex,
    Call,
    ToString,
    Pairs,
    Close,
    Gc,
}

Public metamethod kinds for UserdataMethods::add_meta_method.

Maps 1:1 onto the dispatcher’s internal Mm enum. Listed explicitly so the public surface doesn’t leak Mm’s discriminant layout — Mm stays pub(crate) in exec.rs.

Not all Mm variants are exposed: Mm::Metatable (the __metatable guard) and Mm::Name are set indirectly via LuaUserdata::type_name and getmetatable; surfacing them as add_meta_method targets would be confusing.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Add

__add — binary +.

Sub

__sub — binary -.

Mul

__mul — binary *.

Div

__div — binary /.

Mod

__mod — binary %.

Pow

__pow — binary ^.

IDiv

__idiv — binary //.

BAnd

__band — binary &.

BOr

__bor — binary |.

BXor

__bxor — binary ~ (bitwise xor).

Shl

__shl — <<.

Shr

__shr — >>.

BNot

__bnot — unary ~.

Unm

__unm — unary -.

Concat

__concat — binary ...

Len

__len — unary #.

Eq

__eq — ==.

Lt

__lt — <.

Le

__le — <=.

Index

__index — non-existent key lookup. Setting this directly overrides the per-method dispatch table installed by UserdataMethods::add_method etc., so only use it when you want full control of the lookup; the trait’s default __index is a table of add_method entries.

NewIndex

__newindex — non-existent key assignment.

Call

__call — obj(args).

ToString

__tostring — tostring(obj).

Pairs

__pairs — pairs(obj) (5.2+).

Close

__close — to-be-closed handler (5.4+).

Gc

__gc — finalizer. The metatable’s __gc fires before Rust’s Drop on the host payload.

Implementations

impl MetaMethod

pub const fn name(self) -> &'static str

Lua-side string spelling of this metamethod ("__add", "__gc", …).

Trait Implementations

impl Clone for MetaMethod

fn clone(&self) -> MetaMethod

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MetaMethod

impl Debug for MetaMethod

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

Formats the value using the given formatter.

impl Eq for MetaMethod

impl PartialEq for MetaMethod

fn eq(&self, other: &MetaMethod) -> 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 StructuralPartialEq for MetaMethod