Struct glsp::Sym

pub struct Sym(_, _);

The sym primitive type.

Symbols are represented by a small Copy type (a 32-bit integer id).

To convert a string into a symbol, you should usually call glsp::sym.

Implementations

impl Sym

pub fn name(&self) -> Rc<str>

Returns the name of the symbol.

For gensyms, the name is the same as its printed representation, e.g. #<gs:tag:8>.

pub fn is_gensym(&self) -> bool

Returns true if this symbol is a gensym.

Gensyms are constructed using glsp::gensym or glsp::gensym_with_tag.

impl Sym

pub fn is_representable(&self) -> bool

Returns true if this symbol can be losslessly converted to text.

pub fn check_representability(&self) -> Result<(), &'static str>

Returns Ok if this symbol can be losslessly converted to text.

pub fn is_serializable(&self) -> bool

Returns true if this symbol can be serialized and deserialized using Serde.

This method is only present when the "serde" feature is enabled.

pub fn check_serializability(&self) -> Result<(), &'static str>

Returns Ok if this symbol can be serialized and deserialized using Serde.

This method is only present when the "serde" feature is enabled.

Trait Implementations

impl Clone for Sym

pub fn clone(&self) -> Sym

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Sym

impl Debug for Sym

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sym

pub fn deserialize<D>(d: D) -> Result<Sym, <D as Deserializer<'de>>::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Sym

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

Formats the value using the given formatter.

impl Eq for Sym

impl From<SymBytes> for Sym

pub fn from(src: SymBytes) -> Sym

Performs the conversion.

impl FromVal for Sym

pub fn from_val(val: &Val) -> Result<Sym, GError>

impl Hash for Sym

pub fn hash<__H>(&self, state: &mut __H) where
    __H: Hasher, 

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<'a> IntoVal for &'a Sym

pub fn into_val(self) -> Result<Val, GError>

impl IntoVal for Sym

pub fn into_val(self) -> Result<Val, GError>

impl<'a> IntoVal for &'a mut Sym

pub fn into_val(self) -> Result<Val, GError>

impl Ord for Sym

pub fn cmp(&self, other: &Sym) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Sym> for Sym

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

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

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

This method tests for !=.

impl PartialOrd<Sym> for Sym

pub fn partial_cmp(&self, other: &Sym) -> Option<Ordering>

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub 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 Serialize for Sym

pub fn serialize<S>(
    &self,
    s: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl StructuralEq for Sym

impl StructuralPartialEq for Sym

impl ToSym for Sym

pub fn to_sym(&self) -> Result<Sym, GError>