Struct Encoding

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

An encoding for String.

Implementations

impl Encoding

pub fn ascii_8bit() -> Encoding

Returns the ASCII-8BIT encoding.

Examples

This is essentially an “anything goes” encoding:

use rosy::string::{String, Encoding};

let bytes: &[u8] = &[b'a', b'z', 0, 255];
let string = String::from(bytes);

assert_eq!(string.encoding(), Encoding::ascii_8bit());

pub fn utf8() -> Encoding

Returns the UTF-8 encoding.

Examples

use rosy::string::Encoding;

let utf8 = Encoding::find("UTF-8\0").unwrap();
assert_eq!(utf8, Encoding::utf8());

pub fn us_ascii() -> Encoding

Returns the US-ASCII encoding.

Examples

use rosy::string::Encoding;

let ascii = Encoding::find("US-ASCII\0").unwrap();
assert_eq!(ascii, Encoding::us_ascii());

pub fn find<E>(encoding: E) -> Result<Self, EncodingLookupError>

where E: TryInto<Self, Error = EncodingLookupError>,

Attempts to find encoding, returning an error if either:

• encoding cannot be passed in as a nul-terminated C string.
• The requested encoding was not found.

Examples

Looking up an encoding is straightforward since Rust allows for embedding nul bytes in its UTF-8 strings:

use rosy::string::Encoding;

let utf8 = Encoding::find("UTF-8\0").unwrap();
let ascii = Encoding::find("US-ASCII\0").unwrap();

assert_ne!(utf8, ascii);

pub fn name(&self) -> &CStr

Returns the encoding’s name.

Examples

use rosy::string::Encoding;

assert_eq!(Encoding::utf8().name().to_bytes(), b"UTF-8");

pub fn is_ascii_8bit(self) -> bool

Returns whether self is ASCII-8BIT.

pub fn is_utf8(self) -> bool

Returns whether self is UTF-8.

pub fn is_us_ascii(self) -> bool

Returns whether self is US-ASCII.

pub fn is_locale(self) -> bool

Returns whether self is the locale encoding.

pub fn is_filesystem(self) -> bool

Returns whether self is the filesystem encoding.

pub fn is_default_external(self) -> bool

Returns whether self is the default external encoding.

pub fn is_default_internal(self) -> bool

Returns whether self is the default internal encoding.

Trait Implementations

impl AsRef<AnyObject> for Encoding

fn as_ref(&self) -> &AnyObject

Converts this type into a shared reference of the (usually inferred) input type.

impl Classify for Encoding

fn class() -> Class<Self>

Returns the typed class that can be used to get an instance of self.

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 Display for Encoding

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

Formats the value using the given formatter.

impl From<Encoding> for AnyObject

fn from(object: Encoding) -> AnyObject

Converts to this type from the input type.

impl Object for Encoding

fn cast<A: Object>(obj: A) -> Option<Self>

Attempts to create an instance by casting obj.

fn unique_id() -> Option<u128>

Returns a unique identifier for an object type to facilitate casting.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

unsafe fn cast_unchecked(obj: impl Object) -> Self

Casts obj to Self without checking its type.

fn into_any_object(self) -> AnyObject

Returns self as an AnyObject.

fn as_any_object(&self) -> &AnyObject

Returns a reference to self as an AnyObject.

fn as_any_slice(&self) -> &[AnyObject]

Returns self as a reference to a single-element slice.

fn raw(self) -> usize

Returns the raw object pointer.

unsafe fn as_unchecked<O: Object>(&self) -> &O

Casts self to O without checking whether it is one.

unsafe fn into_unchecked<O: Object>(self) -> O

Converts self to O without checking whether it is one.

fn id(self) -> u64

Returns the object’s identifier.

fn ty(self) -> Ty

Returns the virtual type of self.

fn is_ty(self, ty: Ty) -> bool

Returns whether the virtual type of self is ty.

fn class(self) -> Class<Self>

Returns the Class for self.

fn singleton_class(self) -> Class<Self>

Returns the singleton Class of self, creating one if it doesn’t exist already.

fn mark(self)

Marks self for Ruby to avoid garbage collecting it.

unsafe fn force_recycle(self)

Forces the garbage collector to free the contents of self.

fn def_singleton_method<N, F>(self, name: N, f: F) -> Result

where N: Into<SymbolId>, F: MethodFn<Self>,

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F)

where N: Into<SymbolId>, F: MethodFn<Self>,

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn call(self, method: impl Into<SymbolId>) -> AnyObject

Calls method on self and returns its output.

unsafe fn call_protected(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls method on self and returns its output, or an exception if one is raised.

unsafe fn call_with( self, method: impl Into<SymbolId>, args: &[impl Object], ) -> AnyObject

Calls method on self with args and returns its output.

unsafe fn call_with_protected( self, method: impl Into<SymbolId>, args: &[impl Object], ) -> Result<AnyObject>

Calls method on self with args and returns its output, or an exception if one is raised.

unsafe fn call_public(self, method: impl Into<SymbolId>) -> AnyObject

Calls the public method on self and returns its output.

unsafe fn call_public_protected( self, method: impl Into<SymbolId>, ) -> Result<AnyObject>

Calls the public method on self and returns its output, or an exception if one is raised.

unsafe fn call_public_with( self, method: impl Into<SymbolId>, args: &[impl Object], ) -> AnyObject

Calls the public method on self with args and returns its output.

unsafe fn call_public_with_protected( self, method: impl Into<SymbolId>, args: &[impl Object], ) -> Result<AnyObject>

Calls the public method on self with args and returns its output, or an exception if one is raised.

fn inspect(self) -> String

Returns a printable string representation of self.

fn to_s(self) -> String

Returns the result of calling the to_s method on self.

fn is_frozen(self) -> bool

Returns whether modifications can be made to self.

fn freeze(self)

Freezes self, preventing any further mutations.

fn is_eql<O: Object>(self, other: &O) -> bool

Returns whether self is equal to other in terms of the eql? method.

fn get_attr<N: Into<SymbolId>>(self, name: N) -> AnyObject

Returns the value for the attribute of self associated with name.

unsafe fn eval(self, args: impl EvalArgs) -> AnyObject

Evaluates args in the context of self.

unsafe fn eval_protected(self, args: impl EvalArgs) -> Result<AnyObject>

Evaluates args in the context of self, returning any raised exceptions.

impl PartialEq<AnyObject> for Encoding

fn eq(&self, obj: &AnyObject) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Encoding

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&[u8]> for Encoding

type Error = EncodingLookupError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&CStr> for Encoding

type Error = EncodingLookupError

The type returned in the event of a conversion error.

fn try_from(s: &CStr) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&CString> for Encoding

type Error = EncodingLookupError

The type returned in the event of a conversion error.

fn try_from(s: &CString) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&String> for Encoding

type Error = EncodingLookupError

The type returned in the event of a conversion error.

fn try_from(s: &String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&Vec<u8>> for Encoding

type Error = EncodingLookupError

The type returned in the event of a conversion error.

fn try_from(bytes: &Vec<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&str> for Encoding

type Error = EncodingLookupError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Encoding

impl Eq for Encoding