PyMetadata

Struct PyMetadata 

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

Dictionary metadata configuration.

Contains all configuration parameters for building and using dictionaries.

§Fields

  • name - Dictionary name
  • encoding - Character encoding (default: “UTF-8”)
  • compress_algorithm - Compression algorithm (default: Deflate)
  • default_word_cost - Default cost for unknown words (default: -10000)
  • default_left_context_id - Default left context ID (default: 1288)
  • default_right_context_id - Default right context ID (default: 1288)
  • default_field_value - Default value for missing fields (default: “*”)
  • flexible_csv - Allow flexible CSV parsing (default: false)
  • skip_invalid_cost_or_id - Skip entries with invalid cost/ID (default: false)
  • normalize_details - Normalize morphological details (default: false)
  • dictionary_schema - Schema for main dictionary
  • user_dictionary_schema - Schema for user dictionary

Implementations§

Source§

impl PyMetadata

Source

pub fn new( name: Option<String>, encoding: Option<String>, compress_algorithm: Option<PyCompressionAlgorithm>, default_word_cost: Option<i16>, default_left_context_id: Option<u16>, default_right_context_id: Option<u16>, default_field_value: Option<String>, flexible_csv: Option<bool>, skip_invalid_cost_or_id: Option<bool>, normalize_details: Option<bool>, dictionary_schema: Option<PySchema>, user_dictionary_schema: Option<PySchema>, ) -> Self

Source

pub fn create_default() -> Self

Source

pub fn from_json_file(path: &str) -> PyResult<Self>

Source

pub fn name(&self) -> &str

Source

pub fn set_name(&mut self, name: String)

Source

pub fn encoding(&self) -> &str

Source

pub fn set_encoding(&mut self, encoding: String)

Source

pub fn compress_algorithm(&self) -> PyCompressionAlgorithm

Source

pub fn set_compress_algorithm(&mut self, algorithm: PyCompressionAlgorithm)

Source

pub fn default_word_cost(&self) -> i16

Source

pub fn set_default_word_cost(&mut self, cost: i16)

Source

pub fn default_left_context_id(&self) -> u16

Source

pub fn set_default_left_context_id(&mut self, id: u16)

Source

pub fn default_right_context_id(&self) -> u16

Source

pub fn set_default_right_context_id(&mut self, id: u16)

Source

pub fn default_field_value(&self) -> &str

Source

pub fn set_default_field_value(&mut self, value: String)

Source

pub fn flexible_csv(&self) -> bool

Source

pub fn set_flexible_csv(&mut self, value: bool)

Source

pub fn skip_invalid_cost_or_id(&self) -> bool

Source

pub fn set_skip_invalid_cost_or_id(&mut self, value: bool)

Source

pub fn normalize_details(&self) -> bool

Source

pub fn set_normalize_details(&mut self, value: bool)

Source

pub fn dictionary_schema(&self) -> PySchema

Source

pub fn set_dictionary_schema(&mut self, schema: PySchema)

Source

pub fn user_dictionary_schema(&self) -> PySchema

Source

pub fn set_user_dictionary_schema(&mut self, schema: PySchema)

Source

pub fn to_dict(&self) -> HashMap<String, String>

Trait Implementations§

Source§

impl Clone for PyMetadata

Source§

fn clone(&self) -> PyMetadata

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PyMetadata

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<Metadata> for PyMetadata

Source§

fn from(metadata: Metadata) -> Self

Converts to this type from the input type.
Source§

impl From<PyMetadata> for Metadata

Source§

fn from(metadata: PyMetadata) -> Self

Converts to this type from the input type.
Source§

impl<'py> IntoPyObject<'py> for PyMetadata

Source§

type Target = PyMetadata

The Python output type
Source§

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

The smart pointer type to use. Read more
Source§

type Error = PyErr

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

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

Performs the conversion.
Source§

impl PyClass for PyMetadata

Source§

type Frozen = False

Whether the pyclass is frozen. Read more
Source§

impl PyClassImpl for PyMetadata

Source§

const IS_BASETYPE: bool = false

#[pyclass(subclass)]
Source§

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]
Source§

const IS_MAPPING: bool = false

#[pyclass(mapping)]
Source§

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]
Source§

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]
Source§

const RAW_DOC: &'static CStr = /// Dictionary metadata configuration. /// /// Contains all configuration parameters for building and using dictionaries. /// /// # Fields /// /// * `name` - Dictionary name /// * `encoding` - Character encoding (default: "UTF-8") /// * `compress_algorithm` - Compression algorithm (default: Deflate) /// * `default_word_cost` - Default cost for unknown words (default: -10000) /// * `default_left_context_id` - Default left context ID (default: 1288) /// * `default_right_context_id` - Default right context ID (default: 1288) /// * `default_field_value` - Default value for missing fields (default: "*") /// * `flexible_csv` - Allow flexible CSV parsing (default: false) /// * `skip_invalid_cost_or_id` - Skip entries with invalid cost/ID (default: false) /// * `normalize_details` - Normalize morphological details (default: false) /// * `dictionary_schema` - Schema for main dictionary /// * `user_dictionary_schema` - Schema for user dictionary

Docstring for the class provided on the struct or enum. Read more
Source§

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined. Read more
Source§

type BaseType = PyAny

Base class
Source§

type ThreadChecker = SendablePyClass<PyMetadata>

This handles following two situations: Read more
Source§

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

Immutable or mutable
Source§

type Dict = PyClassDummySlot

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

type WeakRef = PyClassDummySlot

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

type BaseNativeType = PyAny

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

fn items_iter() -> PyClassItemsIter

Source§

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

Source§

fn dict_offset() -> Option<isize>

Source§

fn weaklist_offset() -> Option<isize>

Source§

impl PyClassNewTextSignature for PyMetadata

Source§

const TEXT_SIGNATURE: &'static str = "(name=None, encoding=None, compress_algorithm=None, default_word_cost=None, default_left_context_id=None, default_right_context_id=None, default_field_value=None, flexible_csv=None, skip_invalid_cost_or_id=None, normalize_details=None, dictionary_schema=None, user_dictionary_schema=None)"

Source§

impl PyMethods<PyMetadata> for PyClassImplCollector<PyMetadata>

Source§

fn py_methods(self) -> &'static PyClassItems

Source§

impl PyTypeInfo for PyMetadata

Source§

const NAME: &'static str = "Metadata"

Class name.
Source§

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

Module name, if any.
Source§

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

Returns the PyTypeObject instance for this type.
Source§

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

Returns the safe abstraction over the type object.
Source§

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

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

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

Checks if object is an instance of this type.
Source§

impl DerefToPyAny for PyMetadata

Source§

impl ExtractPyClassWithClone for PyMetadata

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<'a, 'py, T> FromPyObject<'a, 'py> for T
where T: PyClass + Clone + ExtractPyClassWithClone,

Source§

type Error = PyClassGuardError<'a, 'py>

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

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

Extracts Self from the bound smart pointer obj. 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<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

Source§

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.
Source§

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.
Source§

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more
Source§

impl<T> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

Source§

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception
Source§

impl<T> PyTypeCheck for T
where T: PyTypeInfo,

Source§

const NAME: &'static str = T::NAME

👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
Source§

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

Checks if object is an instance of Self, which may include a subtype. Read more
Source§

fn classinfo_object(py: Python<'_>) -> Bound<'_, PyAny>

Returns the expected type as a possible argument for the isinstance and issubclass function. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<'py, T> FromPyObjectOwned<'py> for T
where T: for<'a> FromPyObject<'a, 'py>,

Source§

impl<T> SendAlias for T

Source§

impl<T> SendSyncUnwindSafe for T
where T: Send + Sync + UnwindSafe + ?Sized,

Source§

impl<T> SyncAlias for T

Source§

impl<T> Ungil for T
where T: Send,