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, PyObject>>, ) -> PyResult<Self>

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

Trait Implementations

impl IntoPy<Py<PyAny>> for FormatParser

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0:

IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

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<'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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for FormatParser

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<FormatParser>

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<FormatParser> for PyClassImplCollector<FormatParser>

fn new_text_signature(self) -> Option<&'static str>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a FormatParser

type Holder = Option<PyRef<'py, FormatParser>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a mut FormatParser

type Holder = Option<PyRefMut<'py, FormatParser>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<FormatParser> for PyClassImplCollector<FormatParser>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for FormatParser

const NAME: &'static str = "FormatParser"

Class name.

const MODULE: Option<&'static str>

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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0:

renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0:

renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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

Checks if object is an instance of this type.

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

👎Deprecated since 0.23.0:

renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for FormatParser