Struct magnus::value::Id

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

The internal value of a Ruby symbol.

Implementations

impl Id

pub fn new<T>(name: T) -> Selfwhere T: AsRef<str>,

Create a new Id for name.

Panics

Panics if called from a non-Ruby thread.

Examples

use magnus::value::Id;

let id = Id::new("example");
assert_eq!(id.name().unwrap(), "example");

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

Return the Id for name, if one exists.

Panics

Panics if called from a non-Ruby thread.

Examples

use magnus::{value::Id, StaticSymbol};

assert!(Id::check("example").is_none());
StaticSymbol::new("example");
assert!(Id::check("example").is_some());

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

Return the symbol name associated with this Id as a static string reference.

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

Examples

use magnus::value::Id;

let id = Id::new("example");
assert_eq!(id.name().unwrap(), "example");

Trait Implementations

impl AsRawId for Id

Available on crate feature rb-sys-interop only.

fn as_raw(self) -> ID

Convert magnus::value::Id to rb_sys::ID.

impl Clone for Id

fn clone(&self) -> Id

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Id

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

Formats the value using the given formatter.

impl From<Id> for StaticSymbol

fn from(id: Id) -> Self

Converts to this type from the input type.

impl From<Id> for Symbol

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<Symbol> for Id

fn from(sym: Symbol) -> Self

Converts to this type from the input type.

impl FromRawId for Id

Available on crate feature rb-sys-interop only.

unsafe fn from_raw(id: ID) -> Id

Convert rb_sys::ID to magnus::value::Id.

impl IntoId for Id

fn into_id_with(self, _: &RubyHandle) -> Id

Convert self into Id.

fn into_id(self) -> Id

Convert self into Id.

unsafe fn into_id_unchecked(self) -> Id

Convert self into Id.

impl PartialEq<Id> for Id

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Id

impl StructuralPartialEq for Id