Struct DataType 

pub struct DataType { /* private fields */ }

Represents a data type including metadata.

Implementations

impl DataType

pub fn new( type_name: &str, metadata: Option<Params>, identifier: Option<String>, ) -> Self

Creates a new DataType instance.

pub fn from_parts( type_name: &str, topic: &str, metadata: Option<Params>, ) -> Self

Creates a DataType from persisted parts (type_name, topic, metadata). Hash is recomputed from topic. Use when restoring from legacy data_type column. Identifier is set to None.

pub fn to_persistence_json(&self) -> Result<String, Error>

Serializes to JSON for persistence (type_name, metadata, identifier; no topic, no hash).

Errors

Returns a JSON serialization error if the data cannot be serialized.

pub fn from_persistence_json(s: &str) -> Result<Self, Error>

Deserializes from JSON produced by to_persistence_json. Accepts legacy JSON with topic (ignored); topic is rebuilt from type_name + metadata.

Errors

Returns an error if the string is not valid JSON or missing required fields.

pub fn type_name(&self) -> &str

Returns the type name for the data type.

pub fn metadata(&self) -> Option<&Params>

Returns the metadata for the data type.

pub fn metadata_str(&self) -> String

Returns a string representation of the metadata.

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

Returns metadata as a string-only map (e.g. for Arrow schema metadata).

pub fn precomputed_hash(&self) -> u64

Returns the precomputed hash for this data type.

pub fn topic(&self) -> &str

Returns the messaging topic for the data type.

pub fn identifier(&self) -> Option<&str>

Returns the optional catalog path identifier (can contain subdirs, e.g. "venue//symbol").

pub fn instrument_id(&self) -> Option<InstrumentId>

Returns an Option<InstrumentId> parsed from the metadata.

Panics

This function panics if:

• There is no metadata.
• The instrument_id value contained in the metadata is invalid.

pub fn venue(&self) -> Option<Venue>

Returns an Option<Venue> parsed from the metadata.

Panics

This function panics if:

• There is no metadata.
• The venue value contained in the metadata is invalid.

pub fn start(&self) -> Option<UnixNanos>

Returns an Option<UnixNanos> parsed from the metadata start field.

Panics

This function panics if:

• There is no metadata.
• The start value contained in the metadata is invalid.

pub fn end(&self) -> Option<UnixNanos>

Returns an Option<UnixNanos> parsed from the metadata end field.

Panics

This function panics if:

• There is no metadata.
• The end value contained in the metadata is invalid.

pub fn limit(&self) -> Option<usize>

Returns an Option<usize> parsed from the metadata limit field.

Panics

This function panics if:

• There is no metadata.
• The limit value contained in the metadata is invalid.

Trait Implementations

impl Clone for DataType

fn clone(&self) -> DataType

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DataType

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for DataType

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DataType

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

Formats the value using the given formatter.

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

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 Hash for DataType

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'py> IntoPyObject<'py> for DataType

type Target = DataType

The Python output type

type Output = Bound<'py, <DataType 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 Ord for DataType

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for DataType

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for DataType

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PyClass for DataType

const NAME: &str = "DataType"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for DataType

const MODULE: Option<&str>

Module which the class will be associated with.

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 = /// Represents a data type including 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 Layout = <<DataType as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<DataType>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForDataType

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

const TEXT_SIGNATURE: &'static str = "(type_name, metadata=None, identifier=None)"

impl PyStubType for DataType

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for DataType

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.

impl Serialize for DataType

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for DataType

impl Eq for DataType