Struct magnus::r_regexp::RRegexp

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

A Value pointer to a RRegexp struct, Ruby’s internal representation of regular expressions.

See the ReprValue trait for additional methods available on this type. See Ruby for methods to create an RRegexp.

Implementations

impl RRegexp

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

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

Examples

use magnus::{eval, RRegexp};

assert!(RRegexp::from_value(eval("/f(.)o/").unwrap()).is_some());
assert!(RRegexp::from_value(eval(r#""f*""#).unwrap()).is_none());

pub fn new(pattern: &str, opts: Opts) -> Result<Self, Error>

Create a new Regexp from the Rust string pattern.

The encoding of the Ruby regexp will be UTF-8.

Panics

Panics if called from a non-Ruby thread. See Ruby::reg_new for the non-panicking version.

Examples

use magnus::{r_regexp::Opts, rb_assert, RRegexp};

let regexp = RRegexp::new("foo", Opts::new().ignorecase()).unwrap();
rb_assert!(r#"regexp == /foo/i"#, regexp);

pub fn new_str(pattern: RString, opts: Opts) -> Result<Self, Error>

Create a new Regexp from the Ruby string pattern.

Examples

use magnus::{r_regexp::Opts, rb_assert, RRegexp, RString};

let regexp = RRegexp::new_str(RString::new("foo"), Opts::new().ignorecase()).unwrap();
rb_assert!(r#"regexp == /foo/i"#, regexp);

pub fn reg_match<T>(self, s: T) -> Result<Option<usize>, Error>

where T: IntoRString,

Returns the index (in characters) of the first match in s.

Examples

use magnus::RRegexp;

let regexp = RRegexp::new("x", Default::default()).unwrap();
assert_eq!(regexp.reg_match("text").unwrap(), Some(2));
assert_eq!(regexp.reg_match("test").unwrap(), None);

pub fn options(self) -> Opts

Returns the options set for self.

Examples

use magnus::{eval, RRegexp};

let regexp: RRegexp = eval("/x/i").unwrap();
assert!(regexp.options().is_ignorecase());
assert!(!regexp.options().is_multiline());

let regexp: RRegexp = eval("/x/m").unwrap();
assert!(!regexp.options().is_ignorecase());
assert!(regexp.options().is_multiline());

Trait Implementations

impl Clone for RRegexp

fn clone(&self) -> RRegexp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RRegexp

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

Formats the value using the given formatter.

impl Display for RRegexp

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

Formats the value using the given formatter.

impl EncodingCapable for RRegexp

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 IntoValue for RRegexp

fn into_value_with(self, _: &Ruby) -> Value

Convert self into Value.

fn into_value(self) -> Value

Convert self into Value.

unsafe fn into_value_unchecked(self) -> Value

Convert self into Value.

impl ReprValue for RRegexp

fn as_value(self) -> Value

Return self as a Value.

fn is_nil(self) -> bool

Returns whether self is Ruby’s nil value.

fn equal<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #==.

fn eql<T>(self, other: T) -> Result<bool, Error>

where T: ReprValue,

Checks for equality, delegating to the Ruby method #eql?.

fn hash(self) -> Result<Integer, Error>

Returns an integer non-uniquely identifying self.

fn class(self) -> RClass

Returns the class that self is an instance of.

fn is_frozen(self) -> bool

Returns whether self is ‘frozen’.

fn check_frozen(self) -> Result<(), Error>

Returns an error if self is ‘frozen’.

fn freeze(self)

Mark self as frozen.

fn to_bool(self) -> bool

Convert self to a bool, following Ruby’s rules of false and nil as boolean false and everything else boolean true.

fn funcall<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args.

fn funcall_public<M, A, T>(self, method: M, args: A) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the public method named method on self with args.

fn check_funcall<M, A, T>(self, method: M, args: A) -> Option<Result<T, Error>>

where M: IntoId, A: ArgList, T: TryConvert,

If self responds to the method named method, call it with args.

fn funcall_with_block<M, A, T>( self, method: M, args: A, block: Proc ) -> Result<T, Error>

where M: IntoId, A: ArgList, T: TryConvert,

Call the method named method on self with args and block.

fn block_call<M, A, R, T>( self, method: M, args: A, block: fn(_: &[Value], _: Option<Proc>) -> R ) -> Result<T, Error>

where M: IntoId, A: ArgList, R: BlockReturn, T: TryConvert,

Call the method named method on self with args and block.

fn respond_to<M>(self, method: M, include_private: bool) -> Result<bool, Error>

where M: IntoId,

Check if self responds to the given Ruby method.

fn to_r_string(self) -> Result<RString, Error>

Convert self to a Ruby String.

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

Convert self to a Rust string.

fn inspect(self) -> String

Convert self to its Ruby debug representation.

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

Return the name of self’s class.

fn is_kind_of<T>(self, class: T) -> bool

where T: ReprValue + Module,

Returns whether or not self is an instance of class.

fn enumeratorize<M, A>(self, method: M, args: A) -> Enumerator

where M: IntoSymbol, A: ArgList,

Generate an Enumerator from method on self, passing args to method.

impl TryConvert for RRegexp

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

Convert val into Self.

impl Copy for RRegexp