Struct janetrs::JanetAbstract

pub struct JanetAbstract { /* private fields */ }

Type that represents the Janet Abstract type.

Janet Abstract types is the way to expose non-native types to the Janet Runtime and allow the Janet user to interact with them.

It works like a *mut c_void pointer, but the memory it uses are tracked by the Janet Garbage Collector.

Implementations

impl JanetAbstract

pub fn new<A: IsJanetAbstract>(value: A) -> Self

Creates a JanetAbstract using information from the type that can be used as JanetAbstract.

This function manually wraps the value in a ManuallyDrop to avoid the value being dropped when the value is assigned to the JanetAbstract internal raw pointer.

Note that IsJanetAbstract is implemented for ManuallyDrop of any type that implements IsJanetAbstract.

pub unsafe fn from_raw(raw: *mut c_void) -> Self

Creates a JanetAbstract from a raw pointer

Safety

This function doesn’t check anything.

pub unsafe fn get_unchecked<A: IsJanetAbstract>(&self) -> &A::Get

Returns a reference to the abstract type data as A

Safety

This function doesn’t check if the underlying data of the JanetAbstract object and the requested type A are the same.

pub unsafe fn get_mut_unchecked<A: IsJanetAbstract>(&mut self) -> &mut A::Get

Returns a mutable reference to the abstract type data as A

Safety

This function doesn’t check if the underlying data of the JanetAbstract object and the requested type A are the same.

pub fn is<A: IsJanetAbstract>(&self) -> bool

Check if the JanetAbstract data is of the type A.

pub fn get<A: IsJanetAbstract>(&self) -> Result<&A::Get, AbstractError>

Returns a reference to value if it’s the same kind of abstract.

Error

This function may return AbstractError::MismatchedSize if this object size is different of requested type A size, AbstractError::MismatchedAbstractType if any of the function pointer in the JanetAbstractType are different, or AbstractError::NullDataPointer if the JanetAbstract is in a uninitialized state.

pub fn get_mut<A: IsJanetAbstract>( &mut self ) -> Result<&mut A::Get, AbstractError>

Returns a exclusive reference to value if it’s the same kind of abstract.

Error

This function may return AbstractError::MismatchedSize if this object size is different of requested type A size, AbstractError::MismatchedAbstractType if any of the function pointer in the JanetAbstractType are different, or AbstractError::NullDataPointer if the JanetAbstract is in a uninitialized state.

pub fn take<A: IsJanetAbstract>(&mut self) -> Result<A, AbstractError>

Takes the value out of this JanetAbstract, moving it back to an uninitialized state.

Error

This function may return AbstractError::MismatchedSize if this object size is different of requested type A size, AbstractError::MismatchedAbstractType if any of the function pointer in the JanetAbstractType are different, or AbstractError::NullDataPointer if the JanetAbstract is in a uninitialized state.

pub fn into_inner<A: IsJanetAbstract>(self) -> Result<A, AbstractError>

Extracts the value from the ManuallyDrop container.

This allows the value to be dropped again.

Error

This function may return AbstractError::MismatchedSize if this object size is different of requested type A size, AbstractError::MismatchedAbstractType if any of the function pointer in the JanetAbstractType are different, or AbstractError::NullDataPointer if the JanetAbstract is in a uninitialized state.

pub const fn as_raw(&self) -> *const c_void

Acquires the underlying pointer as const pointer.

pub fn as_mut_raw(&mut self) -> *mut c_void

Acquires the underlying pointer.

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

Casts to a pointer of another type.

pub fn size(&self) -> usize

Return the size of the type it holds.

pub fn type_info(&self) -> JanetAbstractType

Return the struct that holds the type name and all possible polymorphic function pointer that a Abstract type can have in Janet.

Trait Implementations

impl Debug for JanetAbstract

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

Formats the value using the given formatter.

impl From<JanetAbstract> for Janet

fn from(val: JanetAbstract) -> Self

Converts to this type from the input type.

impl From<JanetFile> for JanetAbstract

fn from(value: JanetFile) -> Self

Converts to this type from the input type.

impl From<JanetRng> for JanetAbstract

fn from(value: JanetRng) -> Self

Converts to this type from the input type.

impl JanetTypeName for JanetAbstract

fn name() -> String

Returns a string with the name of the type

impl Ord for JanetAbstract

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

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

fn partial_cmp(&self, other: &Self) -> 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 TryFrom<Janet> for JanetAbstract

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 Eq for JanetAbstract

impl StructuralPartialEq for JanetAbstract