Struct janetrs::JanetPointer

pub struct JanetPointer { /* private fields */ }

Janet pointer type.

This type works and behaves as *mut c_void. JanetPointer usage should be avoided, alternatively you can use JanetAbstract instead. It is only used by Janet internally for optimization properties and some Janet modules uses it as well for the same purposes.

Implementations

impl JanetPointer

pub const fn new(ptr: *mut c_void) -> Self

Creates a new JanetPointer

pub fn is_null(&self) -> bool

Returns true if the pointer is null.

pub const fn as_ptr(self) -> *mut c_void

Acquires the underlying *mut pointer.

pub const fn cast<U>(self) -> *mut U

Casts to a pointer of another type.

Trait Implementations

impl Clone for JanetPointer

fn clone(&self) -> JanetPointer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JanetPointer

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

Formats the value using the given formatter.

impl From<&JanetPointer> for Janet

fn from(val: &JanetPointer) -> Self

Converts to this type from the input type.

impl From<JanetPointer> for Janet

fn from(val: JanetPointer) -> Self

Converts to this type from the input type.

impl Hash for JanetPointer

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 JanetTypeName for JanetPointer

fn name() -> String

Returns a string with the name of the type

impl Ord for JanetPointer

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

Restrict a value to a certain interval.

impl PartialEq for JanetPointer

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for JanetPointer

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Pointer for JanetPointer

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

Formats the value using the given formatter.

impl TryFrom<Janet> for JanetPointer

type Error = JanetConversionError

The type returned in the event of a conversion error.

fn try_from(value: Janet) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for JanetPointer

impl Eq for JanetPointer

impl StructuralPartialEq for JanetPointer