Struct rosy::Symbol

#[repr(transparent)]
pub struct Symbol(_);

An instance of Ruby's Symbol class.

Methods

impl Symbol

pub fn is_valid(name: impl AsRef<[u8]>) -> bool

Returns whether name is valid as a symbol value.

Examples

use rosy::Symbol;

assert!(Symbol::is_valid("@hello"));

assert!(!Symbol::is_valid("\0a"));
assert!(!Symbol::is_valid("$"));
assert!(!Symbol::is_valid("@"));
assert!(!Symbol::is_valid(""));

pub fn id(self) -> SymbolId

Returns the identifier associated with this symbol.

pub fn name(self) -> &'static CStr

Returns the symbol's name as a nul-terminated C string.

Trait Implementations

impl GcInfoKey for Symbol

fn stat_gc(self) -> Result<usize>

Returns the status information for self with respect to the garbage collector, or an exception if one is raised.

unsafe fn stat_gc_unchecked(self) -> usize

Returns the status information for self with respect to the garbage collector.

fn latest_gc_info(self) -> Result<AnyObject>

Returns the latest information regarding self with respect to the garbage collector.

unsafe fn latest_gc_info_unchecked(self) -> AnyObject

Returns the latest information regarding self with respect to the garbage collector.

impl Classify for Symbol

fn class() -> Class<Self>

Returns the typed class that can be used to get an instance of self.

impl Object for Symbol

fn cast<A: Object>(obj: A) -> Option<Self>

Attempts to create an instance by casting obj.

fn ty(self) -> Ty

Returns the virtual type of self.

fn is_ty(self, ty: Ty) -> bool

Returns whether the virtual type of self is ty.

fn unique_id() -> Option<u128>

Returns a unique identifier for an object type to facilitate casting.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

unsafe fn cast_unchecked(obj: impl Object) -> Self

Casts obj to Self without checking its type.

fn into_any_object(self) -> AnyObject

Returns self as an AnyObject.

fn as_any_object(&self) -> &AnyObject

Returns a reference to self as an AnyObject.

fn as_any_slice(&self) -> &[AnyObject]

Returns self as a reference to a single-element slice.

fn raw(self) -> usize

Returns the raw object pointer.

unsafe fn as_unchecked<O: Object>(&self) -> &O

Casts self to O without checking whether it is one.

unsafe fn into_unchecked<O: Object>(self) -> O

Converts self to O without checking whether it is one.

fn id(self) -> u64

Returns the object's identifier.

fn class(self) -> Class<Self>

Returns the Class for self.

fn singleton_class(self) -> Class<Self>

Returns the singleton Class of self, creating one if it doesn't exist already.

fn mark(self)

Marks self for Ruby to avoid garbage collecting it.

unsafe fn force_recycle(self)

Forces the garbage collector to free the contents of self.

fn def_singleton_method<N, F>(self, name: N, f: F) -> Result where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F) where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

fn call(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls method on self and returns the result.

unsafe fn call_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls method on self and returns the result.

fn call_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls method on self with args and returns the result.

unsafe fn call_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls method on self with args and returns the result.

fn call_public(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls the public method on self and returns the result.

unsafe fn call_public_unchecked(self, method: impl Into<SymbolId>) -> AnyObject

Calls the public method on self and returns the result.

fn call_public_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls the public method on self with args and returns the result.

unsafe fn call_public_with_unchecked(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls the public method on self with args and returns the result.

fn inspect(self) -> String

Returns a printable string representation of self.

fn to_s(self) -> String

Returns the result of calling the to_s method on self.

fn is_frozen(self) -> bool

Returns whether modifications can be made to self.

fn freeze(self)

Freezes self, preventing any further mutations.

fn is_eql<O: Object>(self, other: &O) -> bool

Returns whether self is equal to other in terms of the eql? method.

impl Copy for Symbol

impl AsRef<AnyObject> for Symbol

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<AnyObject> for Symbol

fn eq(&self, obj: &AnyObject) -> 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 From<Symbol> for AnyObject

fn from(object: Symbol) -> AnyObject

Performs the conversion.

impl From<String> for Symbol

fn from(s: String) -> Symbol

Performs the conversion.

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

fn from(s: &str) -> Symbol

Performs the conversion.

impl From<Symbol> for SymbolId

fn from(s: Symbol) -> Self

Performs the conversion.

impl From<SymbolId> for Symbol

fn from(id: SymbolId) -> Symbol

Performs the conversion.

impl Display for Symbol

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

Formats the value using the given formatter.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl<'_> TryFrom<Symbol> for &'_ str

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(s: Symbol) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Symbol> for String

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(s: Symbol) -> Result<Self, Self::Error>

Performs the conversion.