Enum opcua_server::prelude::Variant

pub enum Variant {
    Empty,
    Boolean(bool),
    SByte(i8),
    Byte(u8),
    Int16(i16),
    UInt16(u16),
    Int32(i32),
    UInt32(u32),
    Int64(i64),
    UInt64(u64),
    Float(f32),
    Double(f64),
    String(UAString),
    DateTime(Box<DateTime>),
    Guid(Box<Guid>),
    StatusCode(StatusCode),
    ByteString(ByteString),
    XmlElement(UAString),
    QualifiedName(Box<QualifiedName>),
    LocalizedText(Box<LocalizedText>),
    NodeId(Box<NodeId>),
    ExpandedNodeId(Box<ExpandedNodeId>),
    ExtensionObject(Box<ExtensionObject>),
    Array(Box<Array>),
}

A Variant holds built-in OPC UA data types, including single and multi dimensional arrays, data values and extension objects.

As variants may be passed around a lot on the stack, Boxes are used for more complex types to keep the size of this type down a bit, especially when used in arrays.

Variants

Empty

Empty type has no value. It is equivalent to a Null value (part 6 5.1.6)

Boolean(bool)

Boolean

SByte(i8)

Signed byte

Byte(u8)

Unsigned byte

Int16(i16)

Signed 16-bit int

UInt16(u16)

Unsigned 16-bit int

Int32(i32)

Signed 32-bit int

UInt32(u32)

Unsigned 32-bit int

Int64(i64)

Signed 64-bit int

UInt64(u64)

Unsigned 64-bit int

Float(f32)

Float

Double(f64)

Double

String(UAString)

String

DateTime(Box<DateTime>)

DateTime

Guid(Box<Guid>)

Guid

StatusCode(StatusCode)

StatusCode

ByteString(ByteString)

ByteString

XmlElement(UAString)

XmlElement

QualifiedName(Box<QualifiedName>)

QualifiedName

LocalizedText(Box<LocalizedText>)

LocalizedText

NodeId(Box<NodeId>)

NodeId

ExpandedNodeId(Box<ExpandedNodeId>)

ExpandedNodeId

ExtensionObject(Box<ExtensionObject>)

ExtensionObject

Array(Box<Array>)

Single dimension array which can contain any scalar type, all the same type. Nested arrays will be rejected.

Implementations

impl Variant

pub fn test_encoding_flag(encoding_mask: u8, data_type_id: DataTypeId) -> bool

Test the flag (convenience method)

pub fn cast(&self, target_type: VariantTypeId) -> Variant

Performs an EXPLICIT cast from one type to another. This will first attempt an implicit conversion and only then attempt to cast. Casting is potentially lossy.

pub fn convert(&self, target_type: VariantTypeId) -> Variant

Performs an IMPLICIT conversion from one type to another

pub fn type_id(&self) -> VariantTypeId

pub fn is_numeric(&self) -> bool

Tests and returns true if the variant holds a numeric type

pub fn is_array(&self) -> bool

Test if the variant holds an array

pub fn is_array_of_type(&self, variant_type: VariantTypeId) -> bool

pub fn is_valid(&self) -> bool

Tests that the variant is in a valid state. In particular for arrays ensuring that the values are all acceptable and for a multi dimensional array that the dimensions equal the actual values.

pub fn as_f64(&self) -> Option<f64>

Converts the numeric type to a double or returns None

pub fn array_data_type(&self) -> Option<NodeId>

pub fn scalar_data_type(&self) -> Option<NodeId>

pub fn to_byte_array(&self) -> Variant

This function is for a special edge case of converting a byte string to a single array of bytes

pub fn eq_scalar_type(&self, other: &Variant) -> bool

pub fn eq_array_type(&self, other: &Variant) -> bool

pub fn set_range_of(
    &mut self,
    range: NumericRange,
    other: &Variant
) -> Result<(), StatusCode>

pub fn range_of(&self, range: NumericRange) -> Result<Variant, StatusCode>

This function gets a range of values from the variant if it is an array, or returns a clone of the variant itself.

Trait Implementations

impl BinaryEncoder<Variant> for Variant

fn byte_len(&self) -> usize

Returns the exact byte length of the structure as it would be if encode were called. This may be called prior to writing to ensure the correct amount of space is available.

fn encode<S>(&self, stream: &mut S) -> Result<usize, StatusCode> where
    S: Write, 

Encodes the instance to the write stream.

fn decode<S>(
    stream: &mut S,
    decoding_limits: &DecodingLimits
) -> Result<Variant, StatusCode> where
    S: Read, 

Decodes an instance from the read stream. The decoding limits are restrictions set by the server / client on the length of strings, arrays etc. If these limits are exceeded the implementation should return with a BadDecodingError as soon as possible.

fn encode_to_vec(&self) -> Vec<u8>

impl Clone for Variant

fn clone(&self) -> Variant

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Variant

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

Formats the value using the given formatter.

impl Default for Variant

fn default() -> Variant

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Variant

fn deserialize<__D>(
    __deserializer: __D
) -> Result<Variant, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Display for Variant

This implementation is mainly for debugging / convenience purposes, to eliminate some of the noise in common types from using the Debug trait.

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

Formats the value using the given formatter.

impl<'a, 'b> From<&'a [&'b str]> for Variant

fn from(v: &'a [&'b str]) -> Variant

Performs the conversion.

impl<'a> From<&'a [String]> for Variant

fn from(v: &'a [String]) -> Variant

Performs the conversion.

impl<'a> From<&'a [bool]> for Variant

fn from(v: &'a [bool]) -> Variant

Performs the conversion.

impl<'a> From<&'a [f32]> for Variant

fn from(v: &'a [f32]) -> Variant

Performs the conversion.

impl<'a> From<&'a [f64]> for Variant

fn from(v: &'a [f64]) -> Variant

Performs the conversion.

impl<'a> From<&'a [i16]> for Variant

fn from(v: &'a [i16]) -> Variant

Performs the conversion.

impl<'a> From<&'a [i32]> for Variant

fn from(v: &'a [i32]) -> Variant

Performs the conversion.

impl<'a> From<&'a [i8]> for Variant

fn from(v: &'a [i8]) -> Variant

Performs the conversion.

impl<'a> From<&'a [u16]> for Variant

fn from(v: &'a [u16]) -> Variant

Performs the conversion.

impl<'a> From<&'a [u32]> for Variant

fn from(v: &'a [u32]) -> Variant

Performs the conversion.

impl<'a> From<&'a [u8]> for Variant

fn from(v: &'a [u8]) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<String>> for Variant

fn from(v: &'a Vec<String>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<bool>> for Variant

fn from(v: &'a Vec<bool>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<f32>> for Variant

fn from(v: &'a Vec<f32>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<f64>> for Variant

fn from(v: &'a Vec<f64>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<i16>> for Variant

fn from(v: &'a Vec<i16>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<i32>> for Variant

fn from(v: &'a Vec<i32>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<i8>> for Variant

fn from(v: &'a Vec<i8>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<u16>> for Variant

fn from(v: &'a Vec<u16>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<u32>> for Variant

fn from(v: &'a Vec<u32>) -> Variant

Performs the conversion.

impl<'a> From<&'a Vec<u8>> for Variant

fn from(v: &'a Vec<u8>) -> Variant

Performs the conversion.

impl<'a> From<&'a str> for Variant

fn from(v: &'a str) -> Variant

Performs the conversion.

impl From<()> for Variant

fn from(()) -> Variant

Performs the conversion.

impl From<(Vec<Variant>, Vec<u32>)> for Variant

fn from(v: (Vec<Variant>, Vec<u32>)) -> Variant

Performs the conversion.

impl From<Array> for Variant

fn from(v: Array) -> Variant

Performs the conversion.

impl From<ByteString> for Variant

fn from(v: ByteString) -> Variant

Performs the conversion.

impl From<DateTime> for Variant

fn from(v: DateTime) -> Variant

Performs the conversion.

impl From<ExpandedNodeId> for Variant

fn from(v: ExpandedNodeId) -> Variant

Performs the conversion.

impl From<ExtensionObject> for Variant

fn from(v: ExtensionObject) -> Variant

Performs the conversion.

impl From<Guid> for Variant

fn from(v: Guid) -> Variant

Performs the conversion.

impl From<LocalizedText> for Variant

fn from(v: LocalizedText) -> Variant

Performs the conversion.

impl From<NodeId> for Variant

fn from(v: NodeId) -> Variant

Performs the conversion.

impl From<QualifiedName> for Variant

fn from(v: QualifiedName) -> Variant

Performs the conversion.

impl From<StatusCode> for Variant

fn from(v: StatusCode) -> Variant

Performs the conversion.

impl From<String> for Variant

fn from(v: String) -> Variant

Performs the conversion.

impl From<UAString> for Variant

fn from(v: UAString) -> Variant

Performs the conversion.

impl From<Variant> for LiteralOperand

fn from(v: Variant) -> LiteralOperand

Performs the conversion.

impl From<Variant> for DataValue

fn from(v: Variant) -> DataValue

Performs the conversion.

impl From<Vec<String>> for Variant

fn from(v: Vec<String>) -> Variant

Performs the conversion.

impl From<Vec<Variant>> for Variant

fn from(v: Vec<Variant>) -> Variant

Performs the conversion.

impl From<Vec<bool>> for Variant

fn from(v: Vec<bool>) -> Variant

Performs the conversion.

impl From<Vec<f32>> for Variant

fn from(v: Vec<f32>) -> Variant

Performs the conversion.

impl From<Vec<f64>> for Variant

fn from(v: Vec<f64>) -> Variant

Performs the conversion.

impl From<Vec<i16>> for Variant

fn from(v: Vec<i16>) -> Variant

Performs the conversion.

impl From<Vec<i32>> for Variant

fn from(v: Vec<i32>) -> Variant

Performs the conversion.

impl From<Vec<i8>> for Variant

fn from(v: Vec<i8>) -> Variant

Performs the conversion.

impl From<Vec<u16>> for Variant

fn from(v: Vec<u16>) -> Variant

Performs the conversion.

impl From<Vec<u32>> for Variant

fn from(v: Vec<u32>) -> Variant

Performs the conversion.

impl From<Vec<u8>> for Variant

fn from(v: Vec<u8>) -> Variant

Performs the conversion.

impl From<bool> for Variant

fn from(v: bool) -> Variant

Performs the conversion.

impl From<f32> for Variant

fn from(v: f32) -> Variant

Performs the conversion.

impl From<f64> for Variant

fn from(v: f64) -> Variant

Performs the conversion.

impl From<i16> for Variant

fn from(v: i16) -> Variant

Performs the conversion.

impl From<i32> for Variant

fn from(v: i32) -> Variant

Performs the conversion.

impl From<i64> for Variant

fn from(v: i64) -> Variant

Performs the conversion.

impl From<i8> for Variant

fn from(v: i8) -> Variant

Performs the conversion.

impl From<u16> for Variant

fn from(v: u16) -> Variant

Performs the conversion.

impl From<u32> for Variant

fn from(v: u32) -> Variant

Performs the conversion.

impl From<u64> for Variant

fn from(v: u64) -> Variant

Performs the conversion.

impl From<u8> for Variant

fn from(v: u8) -> Variant

Performs the conversion.

impl PartialEq<Variant> for Variant

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for Variant

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Variant