Struct PyUserDictionary 

pub struct PyUserDictionary {
    pub inner: UserDictionary,
}

A user-defined dictionary for custom words.

User dictionaries allow you to add custom words and their morphological features that are not present in the main dictionary.

Examples

# Build a user dictionary
lindera.build_user_dictionary("ipadic", "user.csv", "/path/to/output")

# Load it
metadata = lindera.Metadata()
user_dict = lindera.load_user_dictionary("/path/to/output", metadata)

Fields

inner: UserDictionary

Implementations

impl PyUserDictionary

pub fn new(user_dictionary: UserDictionary) -> Self

Trait Implementations

impl Clone for PyUserDictionary

fn clone(&self) -> PyUserDictionary

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'py> IntoPyObject<'py> for PyUserDictionary

type Target = PyUserDictionary

The Python output type

type Output = Bound<'py, <PyUserDictionary 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 PyUserDictionary

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyUserDictionary

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 = /// A user-defined dictionary for custom words. /// /// User dictionaries allow you to add custom words and their morphological features /// that are not present in the main dictionary. /// /// # Examples /// /// ```python /// # Build a user dictionary /// lindera.build_user_dictionary("ipadic", "user.csv", "/path/to/output") /// /// # Load it /// metadata = lindera.Metadata() /// user_dict = lindera.load_user_dictionary("/path/to/output", metadata) /// ```

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 BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyUserDictionary>

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

fn weaklist_offset() -> Option<isize>

impl PyMethods<PyUserDictionary> for PyClassImplCollector<PyUserDictionary>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyUserDictionary

const NAME: &'static str = "UserDictionary"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

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.

impl DerefToPyAny for PyUserDictionary

impl ExtractPyClassWithClone for PyUserDictionary