Struct FormatParser 

pub struct FormatParser {
    pub pattern: String,
    /* private fields */
}

Compiled format pattern for parsing strings.

Construct with :func:formatparse.compile (or FormatParser(pattern, extra_types=...) in Python).

Custom types: converters passed as extra_types at compile time are stored and merged with any extra_types passed per call to parse or search (per-call keys override stored keys).

Pickling: Only the pattern string is serialized. If the parser was built with extra_types, those converters are not restored after unpickling; call compile(pattern, extra_types=...) again with the same mapping.

Fields

pattern: String

Implementations

impl FormatParser

pub fn new(pattern: &str) -> PyResult<Self>

pub fn new_with_extra_types( pattern: &str, extra_types: Option<HashMap<String, Py<PyAny>>>, ) -> PyResult<Self>

pub fn search_pattern( &self, string: &str, case_sensitive: bool, extra_types: Option<HashMap<String, Py<PyAny>>>, evaluate_result: bool, ) -> PyResult<Option<Py<PyAny>>>

Trait Implementations

impl Clone for FormatParser

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DerefToPyAny for FormatParser

impl<'a, 'py> FromPyObject<'a, 'py> for FormatParser

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for FormatParser

type Target = FormatParser

The Python output type

type Output = Bound<'py, <FormatParser as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for FormatParser

const NAME: &str = "FormatParser"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for FormatParser

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Compiled format pattern for parsing strings. /// /// Construct with :func:`formatparse.compile` (or ``FormatParser(pattern, extra_types=...)`` in Python). /// /// **Custom types:** converters passed as ``extra_types`` at compile time are stored /// and merged with any ``extra_types`` passed per call to ``parse`` or ``search`` /// (per-call keys override stored keys). /// /// **Pickling:** Only the pattern string is serialized. If the parser was built /// with ``extra_types``, those converters are **not** restored after unpickling; /// call ``compile(pattern, extra_types=...)`` again with the same mapping.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<FormatParser as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<FormatParser>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for FormatParser

const TEXT_SIGNATURE: &'static str = "(pattern=None, extra_types=None)"

impl PyMethods<FormatParser> for PyClassImplCollector<FormatParser>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for FormatParser

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.