Struct magnus::encoding::Encoding

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

Wrapper type for a Value known to be an instance of Ruby’s Encoding class.

This is the representation of an encoding exposed to Ruby code.

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

Implementations

impl Encoding

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

Return Some(Encoding) if val is an Encoding, None otherwise.

Examples

use magnus::{eval, encoding::Encoding};

assert!(Encoding::from_value(eval("Encoding::US_ASCII").unwrap()).is_some());
assert!(Encoding::from_value(eval("nil").unwrap()).is_none());

pub fn default_external() -> Self

Returns the default internal encoding as a Ruby object.

This is the encoding used for anything out-of-process, such as reading from files or sockets.

pub fn default_internal() -> Option<Self>

Returns the default external encoding as a Ruby object.

If set, any out-of-process data is transcoded from the default external encoding to the default internal encoding.

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 Encoding

fn clone(&self) -> Encoding

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Encoding

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

Formats the value using the given formatter.

impl Deref for Encoding

type Target = Value

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for Encoding

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

Formats the value using the given formatter.

impl From<Encoding> for Index

fn from(val: Encoding) -> Self

Converts to this type from the input type.

impl From<Encoding> for RbEncoding

fn from(val: Encoding) -> Self

Converts to this type from the input type.

impl From<Encoding> for Value

fn from(val: Encoding) -> Self

Converts to this type from the input type.

impl From<RbEncoding> for Encoding

fn from(val: RbEncoding) -> Self

Converts to this type from the input type.

impl Object for Encoding

fn define_singleton_method<M>(self, name: &str, func: M) -> Result<(), Error>where
    M: Method,

Define a singleton method in self’s scope.

fn ivar_get<T, U>(self, name: T) -> Result<U, Error>where
    T: Into<Id>,
    U: TryConvert,

Get the value for the instance variable name within self’s scope.

fn ivar_set<T, U>(self, name: T, value: U) -> Result<(), Error>where
    T: Into<Id>,
    U: Into<Value>,

Set the value for the instance variable name within self’s scope.

fn singleton_class(self) -> Result<RClass, Error>

Finds or creates the singleton class of self.

fn extend_object(self, module: RModule) -> Result<(), Error>

Extend self with module.

impl TryConvert for Encoding

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

Convert val into Self.

impl Copy for Encoding

impl ReprValue for Encoding