Struct magnus::value::StaticSymbol

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

A static Ruby symbol that will live for the life of the program and never be garbage collected.

See also Symbol.

All Value methods should be available on this type through Deref, but some may be missed by this documentation.

Implementations

impl StaticSymbol

pub fn from_value(val: Value) -> Option<Self>

Return Some(StaticSymbol) if val is a StaticSymbol, None otherwise.

Examples

use magnus::{eval, StaticSymbol};

assert!(StaticSymbol::from_value(eval(":foo").unwrap()).is_some());
assert!(StaticSymbol::from_value(eval(r#""bar""#).unwrap()).is_none());
assert!(StaticSymbol::from_value(eval(r#""baz".to_sym"#).unwrap()).is_none());

pub fn new<T: Into<Id>>(name: T) -> Self

Create a new StaticSymbol.

Examples

use magnus::{eval, StaticSymbol};

let sym = StaticSymbol::new("example");
let result: bool = eval!(":example == sym", sym).unwrap();
assert!(result);

pub fn check(name: &str) -> Option<Self>

Return the Id for name, if one exists.

Examples

use magnus::{eval, StaticSymbol};

assert!(StaticSymbol::check("example").is_none());
eval::<StaticSymbol>(":example").unwrap();
assert!(StaticSymbol::check("example").is_some());

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

Return the symbol as a static string reference.

May error if the name is not valid utf-8.

Examples

use magnus::StaticSymbol;

let sym = StaticSymbol::new("example");
assert_eq!(sym.name().unwrap(), "example");

Methods from Deref<Target = Value>

pub unsafe fn to_s(&self) -> Result<Cow<'_, str>, Error>

Convert self to a Rust string.

Safety

This may return a direct view of memory owned and managed by Ruby. Ruby may modify or free the memory backing the returned str, the caller must ensure this does not happen.

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, QTRUE};

let value = QTRUE;
// safe as we neve give Ruby a chance to free the string.
let s = unsafe { value.to_s() }.unwrap().into_owned();
assert_eq!(s, "true");

pub unsafe fn classname(&self) -> Cow<'_, str>

Return the name of self’s class.

Safety

Ruby may modify or free the memory backing the returned str, the caller must ensure this does not happen.

This can be used safely by immediately calling into_owned on the return value.

Examples

use magnus::{eval, RHash};

let value = RHash::new();
// safe as we never give Ruby a chance to free the string.
let s = unsafe { value.classname() }.into_owned();
assert_eq!(s, "Hash");

Trait Implementations

impl Clone for StaticSymbol

fn clone(&self) -> StaticSymbol

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StaticSymbol

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

Formats the value using the given formatter.

impl Deref for StaticSymbol

type Target = Value

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for StaticSymbol

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

Formats the value using the given formatter.

impl EncodingCapable for StaticSymbol

fn enc_get(&self) -> Index

Get the encoding of self.

fn enc_set<T>(&self, enc: T) -> Result<(), Error>where
    T: Into<Index>,

Set self’s encoding.

fn enc_associate<T>(&self, enc: T) -> Result<(), Error>where
    T: Into<Index>,

Set self’s encoding, along with performing additional fix-up self’s contents.

impl From<&str> for StaticSymbol

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<Id> for StaticSymbol

fn from(id: Id) -> Self

Converts to this type from the input type.

impl From<StaticSymbol> for Id

fn from(sym: StaticSymbol) -> Self

Converts to this type from the input type.

impl From<StaticSymbol> for Symbol

fn from(s: StaticSymbol) -> Self

Converts to this type from the input type.

impl From<StaticSymbol> for Value

fn from(val: StaticSymbol) -> Self

Converts to this type from the input type.

impl From<String> for StaticSymbol

fn from(s: String) -> Self

Converts to this type from the input type.

impl TryConvert for StaticSymbol

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

Convert val into Self.

impl Copy for StaticSymbol

impl ReprValue for StaticSymbol