Struct magnus::encoding::Index

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

The index of an encoding in Ruby’s internal encodings table.

This is the type Ruby uses to label encoding capable types, so is used with operations that require reading or setting that label.

Implementations

impl Index

pub fn ascii8bit() -> Self

Returns the index for ASCII-8BIT a.k.a. binary.

pub fn utf8() -> Self

Returns the index for UTF-8.

pub fn usascii() -> Self

Returns the index for US-ASCII.

pub fn locale() -> Self

Returns the index for the process’ current locale encoding.

This is dynamic. If you change the process’ locale that should also change the return value of this function.

pub fn filesystem() -> Self

Returns the index for filesystem encoding.

This is the encoding that Ruby expects data from the OS’ file system to be encoded as, such as directory names.

pub fn find(name: &str) -> Result<Self, Error>

Returns the index for the encoding with the name or alias name.

Examples

use magnus::{eval, encoding};

assert!(encoding::Index::find("UTF-8").is_ok());
assert!(encoding::Index::find("BINARY").is_ok());
assert!(encoding::Index::find("none").is_err());

Trait Implementations

impl Clone for Index

fn clone(&self) -> Index

Returns a copy of the value.

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

Performs copy-assignment from source.

impl From<Encoding> for Index

fn from(val: Encoding) -> Self

Converts to this type from the input type.

impl From<Index> for RbEncoding

fn from(val: Index) -> Self

Converts to this type from the input type.

impl From<RbEncoding> for Index

fn from(val: RbEncoding) -> Self

Converts to this type from the input type.

impl PartialEq<Index> for Index

fn eq(&self, other: &Index) -> 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 TryConvert for Index

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

Convert val into Self.

impl Copy for Index

impl Eq for Index

impl StructuralEq for Index

impl StructuralPartialEq for Index