pub struct PyMetadata { /* private fields */ }Expand description
Dictionary metadata configuration.
Contains all configuration parameters for building and using dictionaries.
§Fields
name- Dictionary nameencoding- 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 dictionaryuser_dictionary_schema- Schema for user dictionary
Implementations§
Source§impl PyMetadata
impl PyMetadata
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
pub fn create_default() -> Self
pub fn from_json_file(path: &str) -> PyResult<Self>
pub fn name(&self) -> &str
pub fn set_name(&mut self, name: String)
pub fn encoding(&self) -> &str
pub fn set_encoding(&mut self, encoding: String)
pub fn compress_algorithm(&self) -> PyCompressionAlgorithm
pub fn set_compress_algorithm(&mut self, algorithm: PyCompressionAlgorithm)
pub fn default_word_cost(&self) -> i16
pub fn set_default_word_cost(&mut self, cost: i16)
pub fn default_left_context_id(&self) -> u16
pub fn set_default_left_context_id(&mut self, id: u16)
pub fn default_right_context_id(&self) -> u16
pub fn set_default_right_context_id(&mut self, id: u16)
pub fn default_field_value(&self) -> &str
pub fn set_default_field_value(&mut self, value: String)
pub fn flexible_csv(&self) -> bool
pub fn set_flexible_csv(&mut self, value: bool)
pub fn skip_invalid_cost_or_id(&self) -> bool
pub fn set_skip_invalid_cost_or_id(&mut self, value: bool)
pub fn normalize_details(&self) -> bool
pub fn set_normalize_details(&mut self, value: bool)
pub fn dictionary_schema(&self) -> PySchema
pub fn set_dictionary_schema(&mut self, schema: PySchema)
pub fn user_dictionary_schema(&self) -> PySchema
pub fn set_user_dictionary_schema(&mut self, schema: PySchema)
pub fn to_dict(&self) -> HashMap<String, String>
Trait Implementations§
Source§impl Clone for PyMetadata
impl Clone for PyMetadata
Source§fn clone(&self) -> PyMetadata
fn clone(&self) -> PyMetadata
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl Debug for PyMetadata
impl Debug for PyMetadata
Source§impl From<Metadata> for PyMetadata
impl From<Metadata> for PyMetadata
Source§impl From<PyMetadata> for Metadata
impl From<PyMetadata> for Metadata
Source§fn from(metadata: PyMetadata) -> Self
fn from(metadata: PyMetadata) -> Self
Converts to this type from the input type.
Source§impl<'py> IntoPyObject<'py> for PyMetadata
impl<'py> IntoPyObject<'py> for PyMetadata
Source§type Target = PyMetadata
type Target = PyMetadata
The Python output type
Source§type Output = Bound<'py, <PyMetadata as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyMetadata as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for PyMetadata
impl PyClass for PyMetadata
Source§impl PyClassImpl for PyMetadata
impl PyClassImpl for PyMetadata
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
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
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
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<PyMetadata>
type ThreadChecker = SendablePyClass<PyMetadata>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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>
Source§impl PyClassNewTextSignature for PyMetadata
impl PyClassNewTextSignature for PyMetadata
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>
impl PyMethods<PyMetadata> for PyClassImplCollector<PyMetadata>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyMetadata
impl PyTypeInfo for PyMetadata
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for PyMetadata
impl ExtractPyClassWithClone for PyMetadata
Auto Trait Implementations§
impl Freeze for PyMetadata
impl RefUnwindSafe for PyMetadata
impl Send for PyMetadata
impl Sync for PyMetadata
impl Unpin for PyMetadata
impl UnwindSafe for PyMetadata
Blanket Implementations§
Source§impl<T> ArchivePointee for T
impl<T> ArchivePointee for T
Source§type ArchivedMetadata = ()
type ArchivedMetadata = ()
The archived version of the pointer metadata for this type.
Source§fn pointer_metadata(
_: &<T as ArchivePointee>::ArchivedMetadata,
) -> <T as Pointee>::Metadata
fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata
Converts some archived metadata to the pointer metadata for itself.
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<'a, 'py, T> FromPyObject<'a, 'py> for T
impl<'a, 'py, T> FromPyObject<'a, 'py> for T
Source§impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
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§impl<T> LayoutRaw for T
impl<T> LayoutRaw for T
Source§fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>
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
impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
Source§unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool
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>>)
fn resolve_niched(out: Place<NichedOption<T, N1>>)
Writes data to
out indicating that a T is niched.Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
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.