Struct Symbol 

pub struct Symbol(/* private fields */);

Ruby Symbol (interned string, immediate value).

Symbols are Ruby’s interned strings - immutable strings that are stored once and reused. They’re commonly used for hash keys and method names.

Symbol is an immediate value and does not require GC protection or pinning.

Example

use solidus::types::Symbol;

let sym = Symbol::new("hello");
assert_eq!(sym.name().unwrap(), "hello");

Implementations

impl Symbol

pub fn new(name: &str) -> Self

Create or get an existing symbol from a string.

Symbols are interned, so calling this with the same string multiple times will return the same Symbol.

Example

use solidus::types::Symbol;

let sym1 = Symbol::new("foo");
let sym2 = Symbol::new("foo");
assert_eq!(sym1.as_value(), sym2.as_value());

pub fn name(self) -> Result<String, Error>

Get the symbol’s name as a String.

Errors

Returns an error if the symbol name contains invalid UTF-8.

Trait Implementations

impl Clone for Symbol

fn clone(&self) -> Symbol

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Symbol

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

Formats the value using the given formatter.

impl IntoValue for Symbol

fn into_value(self) -> Value

Convert self into a Ruby Value.

impl ReprValue for Symbol

fn as_value(self) -> Value

Get this value as a base Value.

unsafe fn from_value_unchecked(val: Value) -> Self

Create from a Value without type checking.

fn as_raw(self) -> VALUE

Get the raw Ruby VALUE.

fn is_nil(self) -> bool

Check if this value is nil.

fn is_truthy(self) -> bool

Check if this value is truthy (not nil or false).

impl TryConvert for Symbol

fn try_convert(val: Value) -> Result<Self, Error>

Try to convert a Ruby Value to this type.

impl Copy for Symbol