Struct janetrs::Janet

source ·

pub struct Janet { /* private fields */ }

Expand description

Janet is the central structure of the Janet Language.

All possible Janet types are represented at some point as this structure, either to receive as arguments ou return something to Janet VM.

§Creating new values

With exception to Janet nil value the best way to create a Janet value is to use the Janet::wrap function, it can receive anything that can be turned Into Janet. For the nil value, there is a nice function for that, the Janet::nil function.

It is also possible to use the From trait to convert as well.

§Examples

use janetrs::Janet;

let j_nil = Janet::nil();
let jnt = Janet::wrap(10); // A Number Janet
let jnt_str = Janet::wrap("Hello"); // A JanetString Janet
let from_jnt = Janet::from(true); // A boolean Janet

§Extracting/Unwrapping Janet values

To extract/unwrap the Janet value you can use the Janet::unwrap method, that will return a TaggedJanet that you can pattern match to use the extracted value.

§Example

use janetrs::{Janet, TaggedJanet};

let jnt = Janet::wrap(10); // A Number Janet

match jnt.unwrap() {
    TaggedJanet::Abstract(jabstract) => {},
    TaggedJanet::Array(array) => {},
    TaggedJanet::Boolean(boolean) => {},
    TaggedJanet::Buffer(buffer) => {},
    TaggedJanet::CFunction(c_fun) => {},
    TaggedJanet::Fiber(fiber) => {},
    TaggedJanet::Function(func) => {},
    TaggedJanet::Keyword(keyword) => {},
    TaggedJanet::Nil => {},
    TaggedJanet::Number(num) => {},
    TaggedJanet::Pointer(ptr) => {},
    TaggedJanet::String(string) => {},
    TaggedJanet::Struct(st) => {},
    TaggedJanet::Symbol(symbol) => {},
    TaggedJanet::Table(table) => {},
    TaggedJanet::Tuple(tuple) => {},
};

To extract/unwrap the Janet value you can use the Janet::try_unwrap method, that will return a Result either with the resulted type of and conversion error.

It is possible to use the TryFrom trait, but that requires to include the trait in the context.

§Example

use janetrs::{Janet, JanetString};

let jnt = Janet::wrap(10); // A Number Janet

let res_num: Result<f64, _> = jnt.try_unwrap();
assert!(res_num.is_ok());

let res_string = jnt.try_unwrap::<JanetString>();
assert!(res_string.is_err());

Struct janetrs::Janet

§Creating new values

§Examples

§Extracting/Unwrapping Janet values

§Example

§Example

Implementations§

impl Janet

pub fn nil() -> Self

pub fn boolean(value: bool) -> Self

pub fn number(value: f64) -> Self

pub fn integer(value: i32) -> Self

pub fn int64(value: i64) -> Self

pub fn uint64(value: u64) -> Self

pub fn array(value: JanetArray<'_>) -> Self

pub fn buffer(value: JanetBuffer<'_>) -> Self

pub fn table(value: JanetTable<'_>) -> Self

pub fn tuple(value: JanetTuple<'_>) -> Self

pub fn string(value: JanetString<'_>) -> Self

pub fn structs(value: JanetStruct<'_>) -> Self

pub fn symbol(value: JanetSymbol<'_>) -> Self

pub fn keyword(value: JanetKeyword<'_>) -> Self

pub fn fiber(value: JanetFiber<'_>) -> Self

pub fn function(value: JanetFunction<'_>) -> Self

pub fn c_function(value: JanetCFunction) -> Self

pub fn pointer(value: JanetPointer) -> Self

pub fn j_abstract(value: JanetAbstract) -> Self

pub fn dynamic(key: impl AsRef<[u8]>) -> Option<Self>

pub fn from_core<'a>(symbol: impl Into<JanetSymbol<'a>>) -> Option<Self>

pub fn wrap(value: impl Into<Self>) -> Self

pub fn unwrap<'data>(self) -> TaggedJanet<'data>

pub fn unwrap_or<T: TryFrom<Self>>(self, default: T) -> T

§Example

pub fn unwrap_or_else<T, F>(self, op: F) -> Twhere T: TryFrom<Self>, F: FnOnce(T::Error) -> T,

§Example

pub fn unwrap_or_default<T>(self) -> Twhere T: TryFrom<Self> + Default,

§Examples

pub fn try_unwrap<T: TryFrom<Self>>(self) -> Result<T, T::Error>

pub fn is_nil(&self) -> bool

pub fn len(&self) -> Option<i32>

pub fn is_empty(&self) -> bool

pub fn is_truthy(&self) -> bool

pub fn get_method(&self, method_name: &str) -> Option<Self>

pub fn has_method(&self, method_name: &str) -> bool

pub fn kind(&self) -> JanetType

pub const fn raw_data(&self) -> CJanet

Trait Implementations§

impl Clone for Janet

fn clone(&self) -> Janet

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

impl Debug for Janet

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

impl DeepEq for Janet

fn deep_eq(&self, other: &Self) -> bool

impl Display for Janet

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

impl Error for Janet

fn source(&self) -> Option<&(dyn Error + 'static)>

fn description(&self) -> &str

fn cause(&self) -> Option<&dyn Error>

fn provide<'a>(&'a self, request: &mut Request<'a>)

impl<'a> Extend<&'a Janet> for JanetArray<'_>

fn extend<T: IntoIterator<Item = &'a Janet>>(&mut self, iter: T)

fn extend_one(&mut self, item: A)

fn extend_reserve(&mut self, additional: usize)

impl Extend<Janet> for JanetArray<'_>

fn extend<T: IntoIterator<Item = Janet>>(&mut self, iter: T)

fn extend_one(&mut self, item: A)

fn extend_reserve(&mut self, additional: usize)

impl From<&Janet> for Janet

fn from(val: &Janet) -> Self

impl From<&Janet> for Janet

fn from(val: &Self) -> Self

impl From<&Janet> for Janet

fn from(val: &CJanet) -> Self

impl From<&JanetArray<'_>> for Janet

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

impl From<&JanetBuffer<'_>> for Janet

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

impl From<&JanetFiber<'_>> for Janet

pub fn unwrap_or_else<T, F>(self, op: F) -> T
where T: TryFrom<Self>, F: FnOnce(T::Error) -> T,

pub fn unwrap_or_default<T>(self) -> T
where T: TryFrom<Self> + Default,