Struct PyFieldDefinition 

pub struct PyFieldDefinition {
    pub index: usize,
    pub name: String,
    pub field_type: PyFieldType,
    pub description: Option<String>,
}

Field definition in dictionary schema.

Describes a single field in the dictionary entry format.

Fields

index: usize

name: String

field_type: PyFieldType

description: Option<String>

Implementations

impl PyFieldDefinition

pub fn new( index: usize, name: String, field_type: PyFieldType, description: Option<String>, ) -> Self

Trait Implementations

impl Clone for PyFieldDefinition

fn clone(&self) -> PyFieldDefinition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PyFieldDefinition

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

Formats the value using the given formatter.

impl From<FieldDefinition> for PyFieldDefinition

fn from(field_def: FieldDefinition) -> Self

Converts to this type from the input type.

impl From<PyFieldDefinition> for FieldDefinition

fn from(field_def: PyFieldDefinition) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for PyFieldDefinition

type Target = PyFieldDefinition

The Python output type

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

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyFieldDefinition

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 = /// Field definition in dictionary schema. /// /// Describes a single field in the dictionary entry format.

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

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 PyClassNewTextSignature for PyFieldDefinition

const TEXT_SIGNATURE: &'static str = "(index, name, field_type, description)"

impl PyMethods<PyFieldDefinition> for PyClassImplCollector<PyFieldDefinition>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyFieldDefinition

const NAME: &'static str = "FieldDefinition"

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 PyFieldDefinition

impl ExtractPyClassWithClone for PyFieldDefinition