Skip to main content

DataType

Enum DataType 

Source
#[repr(i32)]
pub enum DataType {
Show 35 variants Unknown = 0, Int8 = 1, Int16 = 2, Int32 = 3, Int64 = 4, UInt8 = 5, UInt16 = 6, UInt32 = 7, UInt64 = 8, Float = 9, Double = 10, Boolean = 11, String = 12, DateTime = 13, Text = 14, Uuid = 15, DataSet = 16, Bytes = 17, File = 18, Template = 19, PropertySet = 20, PropertySetList = 21, Int8Array = 22, Int16Array = 23, Int32Array = 24, Int64Array = 25, UInt8Array = 26, UInt16Array = 27, UInt32Array = 28, UInt64Array = 29, FloatArray = 30, DoubleArray = 31, BooleanArray = 32, StringArray = 33, DateTimeArray = 34,
}
Expand description

A Sparkplug B data type code.

Values 1..=14 are the basic scalar types (valid as DataSet columns, template parameters, and property values). 15..=19 add UUID/DataSet/Bytes/ File/Template. 20..=21 are property-value-only (PropertySet/list). 22..=34 are the array types.

Variants§

§

Unknown = 0

§

Int8 = 1

§

Int16 = 2

§

Int32 = 3

§

Int64 = 4

§

UInt8 = 5

§

UInt16 = 6

§

UInt32 = 7

§

UInt64 = 8

§

Float = 9

§

Double = 10

§

Boolean = 11

§

String = 12

§

DateTime = 13

§

Text = 14

§

Uuid = 15

§

DataSet = 16

§

Bytes = 17

§

File = 18

§

Template = 19

§

PropertySet = 20

§

PropertySetList = 21

§

Int8Array = 22

§

Int16Array = 23

§

Int32Array = 24

§

Int64Array = 25

§

UInt8Array = 26

§

UInt16Array = 27

§

UInt32Array = 28

§

UInt64Array = 29

§

FloatArray = 30

§

DoubleArray = 31

§

BooleanArray = 32

§

StringArray = 33

§

DateTimeArray = 34

Implementations§

Source§

impl DataType

Source

pub const fn as_u32(self) -> u32

The integer code as it appears on the wire (datatype field, an unsigned 32-bit integer per tck-id-payloads-metric-datatype-value-type).

Source

pub const fn from_u32(v: u32) -> Result<Self>

Parse a wire datatype code, rejecting unknown values (tck-id-payloads-metric-datatype-value).

§Errors

Returns SparkplugError::UnknownDataType for codes outside 0..=34.

Source

pub const fn is_basic(self) -> bool

true for the basic scalar types 1..=14, the only types permitted as DataSet columns and template parameters (tck-id-payloads-dataset-types-value).

Source

pub const fn is_array(self) -> bool

true for the array types 22..=34.

Source

pub const fn array_element_width(self) -> Option<usize>

For numeric/temporal array types, the fixed little-endian element width in bytes. BooleanArray/StringArray use special framing and return None, as do non-array types.

Trait Implementations§

Source§

impl Clone for DataType

Source§

fn clone(&self) -> DataType

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for DataType

Source§

impl Debug for DataType

Source§

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

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

impl Eq for DataType

Source§

impl Hash for DataType

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for DataType

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for DataType

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