Enum MetaMethod

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

Kinds of metamethods that can be overridden.

Currently, this mechanism does not allow overriding the __gc metamethod, since there is generally no need to do so: UserData implementors can instead just implement Drop.

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.

Sub

The - operator.

Mul

The * operator.

Div

The / operator.

Mod

The % operator.

Pow

The ^ operator.

Unm

The unary minus (-) operator.

Concat

The string concatenation operator ...

Len

The length operator #.

Eq

The == operator.

Lt

The < operator.

Le

The <= operator.

Index

Index access obj[key].

NewIndex

Index write access obj[key] = value.

Call

The call “operator” obj(arg1, args2, ...).

ToString

The __tostring metamethod.

This is not an operator, but will be called by methods such as tostring and print.

IPairs

The __ipairs metamethod.

This is not an operator, but it will be called by the built-in ipairs function.

Requires feature = "lua52"

Iter

The __iter metamethod.

Executed before the iteration begins, and should return an iterator function like next (or a custom one).

Requires feature = "lua"

Implementations

impl MetaMethod

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

Returns Lua metamethod name, usually prefixed by two underscores.

Trait Implementations

impl AsRef<str> for MetaMethod

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for MetaMethod

fn clone(&self) -> MetaMethod

Returns a copy of the value.

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

Performs copy-assignment from source.

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, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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<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 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 Copy for MetaMethod

impl Eq for MetaMethod

impl StructuralPartialEq for MetaMethod