Struct janetrs::function::JanetFunction

#[repr(transparent)]
pub struct JanetFunction<'data> { /* fields omitted */ }

A representation of a Janet function defined at the Janet side.

Implementations

impl<'data> JanetFunction<'data>

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

Create a new JanetFunction with a raw pointer.

Safety

This function do not check if the given raw is NULL or not. Use at your own risk.

pub fn call(
    &mut self,
    args: impl AsRef<[Janet]>
) -> Result<Janet, CallError<'data>>

Execute the JanetFunction with the given arguments.

This function may trigger a GC collection.

If the executions was successful returns the output, otherwise return the CallError with information returned by the call.

pub fn call_with_fiber<'fiber>(
    &mut self,
    fiber: JanetFiber<'fiber>,
    args: impl AsRef<[Janet]>
) -> Result<Janet, CallError<'fiber>>

Execute the JanetFunction with the given arguments wising the given fiber.

This function may trigger the a GC collection.

If the executions was successful returns the output, otherwise return the CallError with information returned by the call.

pub fn call_or_panic(&mut self, args: impl AsRef<[Janet]>) -> Janet

Execute the JanetFunction with the given arguments.

This function can not trigger GC collection.

Janet Panics

Panics if anything goes wrong trying to call the function.

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

Return a raw pointer to the function raw structure.

The caller must ensure that the function outlives the pointer this function returns, or else it will end up pointing to garbage.

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

Return a raw mutable pointer to the function raw structure.

The caller must ensure that the function outlives the pointer this function returns, or else it will end up pointing to garbage.

Trait Implementations

impl Debug for JanetFunction<'_>

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

Formats the value using the given formatter.

impl From<JanetFunction<'_>> for Janet

fn from(val: JanetFunction<'_>) -> Self

Performs the conversion.

impl<'data> Ord for JanetFunction<'data>

fn cmp(&self, other: &JanetFunction<'data>) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl<'data> PartialEq<JanetFunction<'data>> for JanetFunction<'data>

fn eq(&self, other: &JanetFunction<'data>) -> bool

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

fn ne(&self, other: &JanetFunction<'data>) -> bool

This method tests for !=.

impl<'data> PartialOrd<JanetFunction<'data>> for JanetFunction<'data>

fn partial_cmp(&self, other: &JanetFunction<'data>) -> Option<Ordering>

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 JanetFunction<'_>

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<'data> Eq for JanetFunction<'data>

impl<'data> StructuralEq for JanetFunction<'data>

impl<'data> StructuralPartialEq for JanetFunction<'data>