Struct Reg 

pub struct Reg(/* private fields */);

Safe wrapper for luaL_Reg, used in module creation.

This type is usually contained within a &[Reg], these slices can be generated easily using the reg! macro or created manually using Reg::new and Reg::END.

See also the reg! macro.

Implementations

impl Reg

pub const END: Self

The terminator of a Reg slice. All slices must have the terminator as their last element.

reg! automatically appends the terminator to the generated slice.

pub const fn new(name: &'static CStr, func: CFunction) -> Self

Manually creates a new Reg element intended to be inserted into a slice.

This function is internally called for you by reg!.

pub const unsafe fn from_raw(raw: luaL_Reg) -> Self

Wraps a pre-existing raw luaL_Reg.

Safety

• name must either be null or a valid string pointer.
• func must either be None or safe to call.

A non-modified luaL_Reg obtained from Reg::into_raw should always be safe to use.

pub const fn into_raw(self) -> luaL_Reg

Returns the wrapped luaL_Reg.

The raw luaL_Reg can be safely converted back into a Reg using Reg::from_raw, as long as it is not modified.

pub const fn name(&self) -> Option<&'static CStr>

Returns the stored function name.

Reg::END will return None instead.

pub const fn func(&self) -> Option<CFunction>

Returns the stored function.

Reg::END will return None instead.

pub const fn is_end(&self) -> bool

Returns true if this Reg is equal to Reg::END, false otherwise.

Trait Implementations

impl Clone for Reg

fn clone(&self) -> Reg

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Reg

impl Debug for Reg

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

Formats the value using the given formatter.