Struct PyLiteral 

pub struct PyLiteral {
    pub value: ScalarValue,
    pub metadata: Option<FieldMetadata>,
}

Fields

value: ScalarValue

metadata: Option<FieldMetadata>

Implementations

impl PyLiteral

pub fn new_with_metadata( value: ScalarValue, metadata: Option<FieldMetadata>, ) -> PyLiteral

impl PyLiteral

pub fn value_f32(&self) -> PyResult<Option<f32>>

pub fn value_f64(&self) -> PyResult<Option<f64>>

pub fn value_decimal128(&self) -> PyResult<(Option<i128>, u8, i8)>

pub fn value_i8(&self) -> PyResult<Option<i8>>

pub fn value_i16(&self) -> PyResult<Option<i16>>

pub fn value_i32(&self) -> PyResult<Option<i32>>

pub fn value_i64(&self) -> PyResult<Option<i64>>

pub fn value_u8(&self) -> PyResult<Option<u8>>

pub fn value_u16(&self) -> PyResult<Option<u16>>

pub fn value_u32(&self) -> PyResult<Option<u32>>

pub fn value_u64(&self) -> PyResult<Option<u64>>

pub fn value_date32(&self) -> PyResult<Option<i32>>

pub fn value_date64(&self) -> PyResult<Option<i64>>

pub fn value_time64(&self) -> PyResult<Option<i64>>

pub fn value_timestamp(&self) -> PyResult<(Option<i64>, Option<String>)>

pub fn value_bool(&self) -> PyResult<Option<bool>>

pub fn value_string(&self) -> PyResult<Option<String>>

pub fn value_interval_day_time(&self) -> PyResult<Option<(i32, i32)>>

Trait Implementations

impl Clone for PyLiteral

fn clone(&self) -> PyLiteral

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DerefToPyAny for PyLiteral

impl From<PyLiteral> for ScalarValue

fn from(lit: PyLiteral) -> ScalarValue

Converts to this type from the input type.

impl From<ScalarValue> for PyLiteral

fn from(value: ScalarValue) -> PyLiteral

Converts to this type from the input type.

impl<'a, 'py> FromPyObject<'a, 'py> for PyLiteral

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

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

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyLiteral

type Target = PyLiteral

The Python output type

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

const NAME: &str = "Literal"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyLiteral

type LayoutAsBase = <PyLiteral as PyClassImpl>::Layout

type BaseNativeType = <PyLiteral as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyLiteral>

type PyClassMutability = <PyLiteral as PyClassImpl>::PyClassMutability

type Layout<T: PyClassImpl> = <<PyLiteral as PyClassBaseType>::BaseNativeType as PyClassBaseType>::Layout<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyClassImpl for PyLiteral

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = true

#[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 = c"\x00"

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 Layout = <<PyLiteral as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyLiteral>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

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

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

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyMethods<PyLiteral> for PyClassImplCollector<PyLiteral>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyLiteral

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

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.