Skip to main content

PyRegex

Struct PyRegex 

Source
pub struct PyRegex { /* private fields */ }
Expand description

A compiled Python-dialect pattern.

Owns the underlying fancy-regex engine and does not expose it. That is deliberate: a third-party type in a public signature is only the same type as the consumer’s when cargo hands both sides one copy, which makes the version requirement on that dependency a source-compatibility surface rather than a private choice. Wrapping it moves the requirement back where it belongs — see “Dependencies in the public API” in the crate docs (#177).

The surface here is what this crate needs plus what reading a match requires; it is not a re-implementation of the engine. A caller that wants the engine itself should depend on fancy-regex directly and pick its own version — this crate deliberately does not re-export ours, because nothing here hands out one of its types for the two to have to agree about.

let re = termproof::pyregex::compile(r"(?<n>\d+)").unwrap();
let caps = re.captures("abc 42").unwrap().unwrap();
assert_eq!(caps.get(0).unwrap().as_str(), "42");
assert_eq!(caps.name("n").unwrap().as_str(), "42");

Implementations§

Source§

impl PyRegex

Source

pub fn as_str(&self) -> &str

The translated pattern the engine was built from.

This is the fancy-regex form, not the Python source: translate rewrites \Z and rejects what Python rejects, so the two differ wherever a rewrite applied.

Kept as our own copy rather than read back from the engine. The engine’s as_str is not stable across its own patch releases — x\z reads back as x$ on fancy-regex 0.16.0 and as x\z on 0.16.2 — so forwarding to it would put an engine-version-dependent answer in this crate’s public API, which is the same class of leak as putting its types there. Found by the test at the declared dependency floors CI step (#177).

Source

pub fn is_match(&self, haystack: &str) -> Result<bool, String>

Whether the pattern matches anywhere in haystack.

Err when the backtracking engine gives up on a pathological pattern. That is not a match and not a reason to end a run; callers here treat it as “no match” and carry on.

Source

pub fn captures<'h>( &self, haystack: &'h str, ) -> Result<Option<PyCaptures<'h>>, String>

The capture groups of the leftmost match, or None when there is none.

Err carries the same meaning as on is_match.

Source

pub fn capture_names(&self) -> impl Iterator<Item = Option<&str>> + '_

Every capture group’s name in group order, None for the unnamed ones.

Group 0 is the whole match and is never named, so the first item is always None.

Trait Implementations§

Source§

impl Debug for PyRegex

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync> ⓘ

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more