Struct HookMask

pub struct HookMask { /* private fields */ }

Structure representing a Lua event mask.

This is used in Lua debug hooks.

Implementations

impl HookMask

pub const INT_CALL: c_int = 1i32

pub const INT_RETURN: c_int = 2i32

pub const INT_LINE: c_int = 4i32

pub const INT_COUNT: c_int = 8i32

pub const fn empty() -> Self

Construct a HookMask with no events that are listened for.

Examples

use lunka::cdef::HookMask;
assert_eq!(HookMask::empty().into_c_int(), 0);

pub const unsafe fn from_c_int_unchecked(mask: c_int) -> Self

Create an instance of this structure using an already-known integer mask.

Safety

The mask must be valid for lua_sethook.

Examples

use lunka::cdef::HookMask;
unsafe {
	assert_eq!(HookMask::from_c_int_unchecked(0), HookMask::empty());
}

pub const fn from_c_int(mask: c_int) -> Self

Create an instance of this structure using an already-known integer mask, and process the mask to only have bits that are valid.

pub const fn into_c_int(self) -> c_int

Consume this structure and return its underlying mask integer.

Examples

use lunka::cdef::HookMask;
assert_eq!(HookMask::empty().into_c_int(), 0);

pub const fn with_calls(self) -> Self

Consume this structure, including in it a flag for function calls.

Examples

use lunka::cdef::HookMask;
assert_eq!(
	HookMask::empty().with_calls().into_c_int(),
	HookMask::INT_CALL
);

pub const fn with_returns(self) -> Self

Consume this structure, including in it a flag for function returns.

Examples

use lunka::cdef::HookMask;
assert_eq!(
	HookMask::empty().with_returns().into_c_int(),
	HookMask::INT_RETURN
);

pub const fn with_lines(self) -> Self

Consume this structure, including in it a flag for advancing lines.

Examples

use lunka::cdef::HookMask;
assert_eq!(
	HookMask::empty().with_lines().into_c_int(),
	HookMask::INT_LINE
);

pub const fn with_instructions(self) -> Self

Consume this structure, including in it a flag for advancing instructions.

Examples

use lunka::cdef::HookMask;
assert_eq!(
	HookMask::empty().with_instructions().into_c_int(),
	HookMask::INT_COUNT
);

instructions.

Trait Implementations

impl Clone for HookMask

fn clone(&self) -> HookMask

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HookMask

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

Formats the value using the given formatter.

impl Default for HookMask

fn default() -> HookMask

Returns the “default value” for a type.

impl Ord for HookMask

fn cmp(&self, other: &HookMask) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for HookMask

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

fn partial_cmp(&self, other: &HookMask) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for HookMask

impl Eq for HookMask

impl StructuralPartialEq for HookMask