Enum MetaMethod 

#[non_exhaustive]
pub enum MetaMethod {
    Add,
    Sub,
    Mul,
    Div,
    Mod,
    Pow,
    Unm,
    IDiv,
    Concat,
    Len,
    Eq,
    Lt,
    Le,
    Index,
    NewIndex,
    Call,
    ToString,
    Iter,
    Type,
}

Kinds of metamethods that can be overridden on userdata.

Mirrors mlua::MetaMethod. The variant set is the Luau-relevant subset (bitwise operators specific to Lua 5.3/5.4 are omitted; Luau does not use them as metamethods).

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

The + operator (__add).

Sub

The - operator (__sub).

Mul

The * operator (__mul).

Div

The / operator (__div).

Mod

The % operator (__mod).

Pow

The ^ operator (__pow).

Unm

The unary minus operator (__unm).

IDiv

The floor-division // operator (__idiv).

Concat

The string concatenation operator .. (__concat).

Len

The length operator # (__len).

Eq

The == operator (__eq).

Lt

The < operator (__lt).

Le

The <= operator (__le).

Index

Index access obj[key] (__index).

NewIndex

Index write access obj[key] = value (__newindex).

Call

The call operator obj(...) (__call).

ToString

The __tostring metamethod.

Iter

The __iter metamethod (Luau).

Type

The __type/__name metafield.

Implementations

impl MetaMethod

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

The Lua metamethod name (e.g. "__add"). Mirrors mlua::MetaMethod::name.

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

Formats the value using the given formatter.

impl Display for MetaMethod

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

Formats the value using the given formatter.

impl Eq for MetaMethod

impl From<MetaMethod> for String

fn from(mm: MetaMethod) -> String

Converts to this type from the input type.

impl Hash for MetaMethod

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 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 PartialEq<MetaMethod> for &str

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 PartialEq<MetaMethod> for String

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