Struct janetrs::JanetSymbol

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

Janet symbol type. Usually used to name things in Janet.

Implementations

impl JanetSymbol<'_>

pub fn new(name: impl AsRef<[u8]>) -> Self

Create a JanetSymbol with given name.

If the given name is bigger than i32::MAX the generated symbol will have a name trucated to that max size. That’s unrealistic thought.

Examples

use janetrs::JanetSymbol;

let s = JanetSymbol::new("name");

pub fn unique() -> Self

Generate a unique Janet symbol. This is used in the library function gensym. The symbol will be of the format _XXXXXX, where X is a base64 digit, and prefix is the argument passed. No prefix for speed.

Examples

use janetrs::JanetSymbol;

let s = JanetSymbol::unique();

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

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

Returns the length of this JanetSymbol, in bytes, not chars or graphemes. In other words, it may not be what a human considers the length of the string.

Examples

use janetrs::JanetSymbol;

let s = JanetSymbol::new("name");
assert_eq!(s.len(), 4);

pub fn is_empty(&self) -> bool

Returns true if this JanetSymbol has a length of zero, and false otherwise.

Examples

use janetrs::JanetSymbol;

let s = JanetSymbol::new("name");
assert!(!s.is_empty());

pub fn as_bytes(&self) -> &[u8]

Returns a byte slice of the JanetString contents.

Examples

use janetrs::JanetSymbol;

let s = JanetSymbol::new("hello");

assert_eq!(&[104, 101, 108, 108, 111], s.as_bytes());

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

Return a raw pointer to the symbol 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 AsRef<[u8]> for JanetSymbol<'_>

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl AsRef<BStr> for JanetSymbol<'_>

fn as_ref(&self) -> &BStr

Performs the conversion.

impl Clone for JanetSymbol<'_>

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

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

Formats the value using the given formatter.

impl Display for JanetSymbol<'_>

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

Formats the value using the given formatter.

impl From<&'_ [u8]> for JanetSymbol<'_>

fn from(bytes: &[u8]) -> Self

Performs the conversion.

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

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

Performs the conversion.

impl From<&'_ JanetKeyword<'_>> for JanetSymbol<'_>

fn from(key: &JanetKeyword<'_>) -> Self

Performs the conversion.

impl From<&'_ JanetString<'_>> for JanetSymbol<'_>

fn from(string: &JanetString<'_>) -> Self

Performs the conversion.

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

fn from(s: &JanetSymbol<'_>) -> Self

Performs the conversion.

impl From<&'_ JanetSymbol<'_>> for JanetString<'_>

fn from(sym: &JanetSymbol<'_>) -> Self

Performs the conversion.

impl From<&'_ JanetSymbol<'_>> for JanetKeyword<'_>

fn from(sym: &JanetSymbol<'_>) -> Self

Performs the conversion.

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

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

Performs the conversion.

impl From<&'_ str> for JanetSymbol<'_>

fn from(rust_str: &str) -> Self

Performs the conversion.

impl From<JanetBuffer<'_>> for JanetSymbol<'_>

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

Performs the conversion.

impl From<JanetKeyword<'_>> for JanetSymbol<'_>

fn from(key: JanetKeyword<'_>) -> Self

Performs the conversion.

impl From<JanetString<'_>> for JanetSymbol<'_>

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

Performs the conversion.

impl From<JanetSymbol<'_>> for JanetBuffer<'_>

fn from(s: JanetSymbol<'_>) -> Self

Performs the conversion.

impl From<JanetSymbol<'_>> for JanetString<'_>

fn from(sym: JanetSymbol<'_>) -> Self

Performs the conversion.

impl From<JanetSymbol<'_>> for JanetKeyword<'_>

fn from(sym: JanetSymbol<'_>) -> Self

Performs the conversion.

impl From<JanetSymbol<'_>> for Janet

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

Performs the conversion.

impl From<String> for JanetSymbol<'_>

fn from(s: String) -> Self

Performs the conversion.

impl From<Vec<u8, Global>> for JanetSymbol<'_>

fn from(vec: Vec<u8>) -> Self

Performs the conversion.

impl FromStr for JanetSymbol<'_>

type Err = Infallible

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Ord for JanetSymbol<'_>

fn cmp(&self, other: &Self) -> 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<'a, 'b> PartialEq<&'a [u8]> for JanetSymbol<'_>

fn eq(&self, other: &&'a [u8]) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<&'a BStr> for JanetSymbol<'_>

fn eq(&self, other: &&'a BStr) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<&'a BString> for JanetSymbol<'_>

fn eq(&self, other: &&'a BString) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<&'a str> for JanetSymbol<'_>

fn eq(&self, other: &&'a str) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<[u8]> for JanetSymbol<'_>

fn eq(&self, other: &[u8]) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<BStr> for JanetSymbol<'_>

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

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<BString> for JanetSymbol<'_>

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<JanetKeyword<'_>> for JanetSymbol<'_>

fn eq(&self, other: &JanetKeyword<'_>) -> bool

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

#[must_use]

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

This method tests for !=.

impl PartialEq<JanetString<'_>> for JanetSymbol<'_>

fn eq(&self, other: &JanetString<'_>) -> bool

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

#[must_use]

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

This method tests for !=.

impl PartialEq<JanetSymbol<'_>> for JanetSymbol<'_>

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

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

#[must_use]

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

This method tests for !=.

impl PartialEq<JanetSymbol<'_>> for JanetString<'_>

fn eq(&self, other: &JanetSymbol<'_>) -> bool

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

#[must_use]

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

This method tests for !=.

impl PartialEq<JanetSymbol<'_>> for JanetKeyword<'_>

fn eq(&self, other: &JanetSymbol<'_>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<String> for JanetSymbol<'_>

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

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<Vec<u8, Global>> for JanetSymbol<'_>

fn eq(&self, other: &Vec<u8>) -> bool

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialEq<str> for JanetSymbol<'_>

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

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

#[must_use]

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

This method tests for !=.

impl<'a, 'b> PartialOrd<&'a [u8]> for JanetSymbol<'_>

fn partial_cmp(&self, other: &&'a [u8]) -> 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<'a, 'b> PartialOrd<&'a BStr> for JanetSymbol<'_>

fn partial_cmp(&self, other: &&'a BStr) -> 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<'a, 'b> PartialOrd<&'a BString> for JanetSymbol<'_>

fn partial_cmp(&self, other: &&'a BString) -> 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<'a, 'b> PartialOrd<&'a str> for JanetSymbol<'_>

fn partial_cmp(&self, other: &&'a str) -> 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<'a, 'b> PartialOrd<[u8]> for JanetSymbol<'_>

fn partial_cmp(&self, other: &[u8]) -> 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<'a, 'b> PartialOrd<BStr> for JanetSymbol<'_>

fn partial_cmp(&self, other: &BStr) -> 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<'a, 'b> PartialOrd<BString> for JanetSymbol<'_>

fn partial_cmp(&self, other: &BString) -> 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 PartialOrd<JanetKeyword<'_>> for JanetSymbol<'_>

fn partial_cmp(&self, other: &JanetKeyword<'_>) -> 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 PartialOrd<JanetString<'_>> for JanetSymbol<'_>

fn partial_cmp(&self, other: &JanetString<'_>) -> 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 PartialOrd<JanetSymbol<'_>> for JanetSymbol<'_>

fn partial_cmp(&self, other: &Self) -> 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 PartialOrd<JanetSymbol<'_>> for JanetString<'_>

fn partial_cmp(&self, other: &JanetSymbol<'_>) -> 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 PartialOrd<JanetSymbol<'_>> for JanetKeyword<'_>

fn partial_cmp(&self, other: &JanetSymbol<'_>) -> 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<'a, 'b> PartialOrd<String> for JanetSymbol<'_>

fn partial_cmp(&self, other: &String) -> 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<'a, 'b> PartialOrd<Vec<u8, Global>> for JanetSymbol<'_>

fn partial_cmp(&self, other: &Vec<u8>) -> 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<'a, 'b> PartialOrd<str> for JanetSymbol<'_>

fn partial_cmp(&self, other: &str) -> 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 JanetSymbol<'_>

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