Struct janetrs::JanetStruct

pub struct JanetStruct<'data> { /* private fields */ }

JanetStructs are immutable data structures that map keys to values.

They are semantically similar to JanetTables, but are immutable. Like JanetTables, they are backed by an efficient, native hash table.

To facilitate the creation of this structure, you can use the macro structs.

Examples

use janetrs::JanetStruct;

let st = JanetStruct::builder(2)
    .put("ten", 10)
    .put("eleven", 11)
    .finalize();

Implementations

impl<'data> JanetStruct<'data>

pub fn builder(len: i32) -> JanetStructBuilder<'data>

Start the build process to create a JanetStruct.

If the given len is lesser than zero it behaves the same as if len is zero.

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

Create a new JanetStruct 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 capacity(&self) -> i32

Returns the number of elements the struct can hold.

pub fn len(&self) -> i32

Returns the number of elements in the struct, also referred to as its ‘length’.

Examples

use janetrs::JanetStruct;

let st = JanetStruct::builder(2)
    .put(10, "ten")
    .put(11, "eleven")
    .finalize();
assert_eq!(st.len(), 2);

pub fn is_empty(&self) -> bool

Returns true if the struct contains no elements.

Examples

use janetrs::JanetStruct;

let st = JanetStruct::builder(2)
    .put(10, "ten")
    .put(11, "eleven")
    .finalize();
assert!(!st.is_empty());

let st = JanetStruct::builder(0).finalize();
assert!(st.is_empty());

pub fn get(&self, key: impl Into<Janet>) -> Option<&Janet>

Returns the value corresponding to the supplied key.

Examples

use janetrs::{Janet, JanetStruct};

let st = JanetStruct::builder(2)
    .put(10, "ten")
    .put(11, "eleven")
    .finalize();
assert_eq!(st.get(10), Some(&Janet::from("ten")));

pub fn get_key_value(&self, key: impl Into<Janet>) -> Option<(&Janet, &Janet)>

Returns the key-value pair corresponding to the supplied key.

Examples

use janetrs::{Janet, JanetStruct};

let st = JanetStruct::builder(2)
    .put(10, "ten")
    .put(11, "eleven")
    .finalize();
assert_eq!(
    st.get_key_value(10),
    Some((&Janet::integer(10), &Janet::from("ten")))
);

pub fn get_owned(&self, key: impl Into<Janet>) -> Option<Janet>

Returns a owned value corresponding to the supplied key.

Examples

use janetrs::{Janet, JanetStruct};

let st = JanetStruct::builder(2)
    .put(10, "ten")
    .put(11, "eleven")
    .finalize();
assert_eq!(st.get_owned(10), Some(Janet::from("ten")));

pub fn get_owned_key_value( &self, key: impl Into<Janet> ) -> Option<(Janet, Janet)>

Returns the key-value pair corresponding to the supplied key.

Examples

use janetrs::{Janet, JanetStruct};

let st = JanetStruct::builder(2).put(10, "ten").put(11, "eleven").finalize();
assert_eq!(st.get_owned_key_value(10), Some((Janet::integer(10), Janet::from("ten"))));

pub fn find(&self, key: impl Into<Janet>) -> Option<(&Janet, &Janet)>

Find the bucket that contains the given key.

Notice that if there is no key-value pair in the table, this function will return a tuple of mutable references to Janet nil.

pub fn contains_key(&self, key: impl Into<Janet>) -> bool

Returns true if the struct contains a value for the specified key.

Examples

use janetrs::{structs, Janet};

let st = structs! {10 => "ten"};

assert!(st.contains_key(10));
assert!(!st.contains_key(11));

pub fn contains(&self, value: impl Into<Janet>) -> bool

Returns true if the struct contains a given value.

Examples

use janetrs::{structs, Janet};

let st = structs! {10 => "ten"};

assert!(st.contains("ten"));
assert!(!st.contains(11));

pub fn keys(&self) -> Keys<'_, '_>

Creates a iterator over the reference of the struct keys.

Examples

use janetrs::structs;

let st = structs! { 1 => "10", true => 10.0};

for key in st.keys() {
    println!("Key: {}", key);
}

pub fn values(&self) -> Values<'_, '_>

Creates a iterator over the reference of the struct values.

Examples

use janetrs::structs;

let st = structs! { 1 => "10", true => 10.0};

for val in st.values() {
    println!("Value: {}", val);
}

pub fn iter(&self) -> Iter<'_, '_>

Creates a iterator over the reference of the struct key-value pairs.

Examples

use janetrs::structs;

let st = structs! { 1 => "10", true => 10.0};

for (k, v) in st.iter() {
    println!("Key: {}\tValue: {}", k, v);
}

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

Return a raw pointer to the struct raw structure.

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

Trait Implementations

impl Clone for JanetStruct<'_>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JanetStruct<'_>

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

Formats the value using the given formatter.

impl DeepEq<JanetStruct<'_>> for JanetTable<'_>

fn deep_eq(&self, other: &JanetStruct<'_>) -> bool

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

impl DeepEq<JanetTable<'_>> for JanetStruct<'_>

fn deep_eq(&self, other: &JanetTable<'_>) -> bool

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

impl DeepEq for JanetStruct<'_>

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

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

impl Default for JanetStruct<'_>

fn default() -> Self

Returns the “default value” for a type.

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

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

Converts to this type from the input type.

impl From<&JanetStruct<'_>> for JanetTable<'_>

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

Converts to this type from the input type.

impl From<&JanetTable<'_>> for JanetStruct<'_>

fn from(table: &JanetTable<'_>) -> Self

Converts to this type from the input type.

impl From<JanetStruct<'_>> for Janet

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

Converts to this type from the input type.

impl From<JanetStruct<'_>> for JanetTable<'_>

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

Converts to this type from the input type.

impl From<JanetTable<'_>> for JanetStruct<'_>

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

Converts to this type from the input type.

impl<U, J> FromIterator<(U, J)> for JanetStruct<'_>

where U: Into<Janet>, J: Into<Janet>,

fn from_iter<T: IntoIterator<Item = (U, J)>>(iter: T) -> Self

Creates a value from an iterator.

impl<T: Into<Janet>> Index<T> for JanetStruct<'_>

fn index(&self, key: T) -> &Self::Output

Get a reference to the value of a given key.

It is recommended to use get method.

Janet Panics

Panics if the struct does not have the key.

type Output = Janet

The returned type after indexing.

impl<'a, 'data> IntoIterator for &'a JanetStruct<'data>

type IntoIter = Iter<'a, 'data>

Which kind of iterator are we turning this into?

type Item = (&'a Janet, &'a Janet)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'data> IntoIterator for JanetStruct<'data>

type IntoIter = IntoIter<'data>

Which kind of iterator are we turning this into?

type Item = (Janet, Janet)

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl JanetTypeName for JanetStruct<'_>

fn name() -> String

Returns a string with the name of the type

impl Ord for JanetStruct<'_>

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

fn eq(&self, other: &Self) -> 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 JanetStruct<'_>

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

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