Struct LuaNodeCursor 

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

Nullable traversal position in a table’s hash-node array.

Unsafe navigation requires cursors from the same live node allocation and an in-bounds non-null position where a node is accessed. Resizing the table invalidates every cursor.

Implementations

impl LuaNodeCursor

pub const fn as_ptr(&self) -> *mut RawLuaNode

Returns the current traversal address, which may be null.

Table resize and rehash invalidate cursors into the old node array.

pub const fn from_ptr(raw: *mut RawLuaNode) -> Self

pub const fn is_null(&self) -> bool

pub unsafe fn node_unchecked(&self) -> LuaNode

pub fn node(&self) -> Option<LuaNode>

pub unsafe fn add(self, count: usize) -> Self

pub unsafe fn sub(self, count: usize) -> Self

pub unsafe fn offset(self, count: isize) -> Self

pub unsafe fn offset_from(self, other: Self) -> isize

Trait Implementations

impl AsRef<LuaNodeCursor> for LuaNodeCursor

fn as_ref(&self) -> &LuaNodeCursor

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

impl Clone for LuaNodeCursor

fn clone(&self) -> LuaNodeCursor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaNodeCursor

impl Eq for LuaNodeCursor

impl Ord for LuaNodeCursor

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

fn eq(&self, other: &LuaNodeCursor) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for LuaNodeCursor

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