Struct DebugWhat

pub struct DebugWhat {
    pub using_function: bool,
    /* private fields */
}

Structure for defining what information needs to be extracted from a function.

This is used in lua_getinfo and ThreadDebug::get_info.

Fields

using_function: bool

Use a function from the stack instead of an activation record.

Implementations

impl DebugWhat

pub const fn nothing() -> Self

Construct an instance with no information required.

pub fn write_string<'a>(&self, buffer: &'a mut [u8]) -> &'a CStr

Write out a “what” string into buffer and return the slice that contains it.

The maximum number of C characters that can be written to buffer is 10, including the zero-terminator.

pub const fn with_func(self) -> Self

Require function (push function onto the stack).

pub const fn with_current_line(self) -> Self

Require current line (current_line).

pub const fn with_name(self) -> Self

Require name information (name, name_what).

pub const fn with_transfer_info(self) -> Self

Require transfer information (first_transferred, n_transferred).

pub const fn with_source_info(self) -> Self

Require source information (source, source_len, short_src, line_defined, last_line_defined, what).

pub const fn with_tail_call_info(self) -> Self

Require tall call information (is_tail_call).

pub const fn with_prototype(self) -> Self

Require function prototype information (n_upvalues, n_params, is_vararg).

pub const fn with_lines(self) -> Self

Require source code lines (push table of them onto the stack).

Trait Implementations

impl Clone for DebugWhat

fn clone(&self) -> DebugWhat

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DebugWhat

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

Formats the value using the given formatter.

impl Ord for DebugWhat

fn cmp(&self, other: &DebugWhat) -> 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 DebugWhat

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

fn partial_cmp(&self, other: &DebugWhat) -> 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 DebugWhat

impl Eq for DebugWhat

impl StructuralPartialEq for DebugWhat