Struct DynamicStructure 

pub struct DynamicStructure { /* private fields */ }

A type representing an OPC-UA structure decoded dynamically. This can use runtime information to properly encode and decode binary information. In order to make the type encodable, it contains references to a StructTypeInfo describing the type it contains, as well as the DataTypeTree containing any types it references.

This type can be used to reason about data on a server without explicitly defining the server types in code, which is useful if you want to create a generic client that can work with data from any server.

Internally it is simply an array of Variant.

Note that this type is intended to support all encoding/decoding types in the OPC-UA standard, which is more than what the encoding macros currently do. This includes structurs with optional fields, unions, and multi-dimensional arrays, none of which are used in the core types.

Implementations

impl DynamicStructure

pub fn new_struct( type_def: Arc<StructTypeInfo>, type_tree: Arc<DataTypeTree>, data: Vec<Variant>, ) -> Result<Self, Error>

Create a new struct, validating that it matches the provided type definition.

pub fn new_union( type_def: Arc<StructTypeInfo>, type_tree: Arc<DataTypeTree>, data: Variant, discriminant: u32, ) -> Result<Self, Error>

Create a new union, validating that it matches the provided type definition.

pub fn new_null_union( type_def: Arc<StructTypeInfo>, type_tree: Arc<DataTypeTree>, ) -> Self

Create a new union, with value null.

pub fn values(&self) -> &[Variant]

Get a reference to the fields in order.

pub fn get_field(&self, index: usize) -> Option<&Variant>

Get a reference to the field at index

pub fn get_field_by_name(&self, name: &str) -> Option<&Variant>

Get a reference to the field with the given name.

Trait Implementations

impl BinaryEncodable for DynamicStructure

fn byte_len(&self, ctx: &Context<'_>) -> 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: Write + ?Sized>( &self, stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<()>

Encodes the instance to the write stream.

fn override_encoding(&self) -> Option<BuiltInDataEncoding>

Override the extension object encoding used for this type. This only makes sense if the type can only ever be encoded using a single built-in encoding.

fn encode_to_vec(&self, ctx: &Context<'_>) -> Vec<u8>

Convenience method for encoding a message straight into an array of bytes. It is preferable to reuse buffers than to call this so it should be reserved for tests and trivial code.

impl Clone for DynamicStructure

fn clone(&self) -> DynamicStructure

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DynamicStructure

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

Formats the value using the given formatter.

impl ExpandedMessageInfo for DynamicStructure

fn full_json_type_id(&self) -> ExpandedNodeId

The JSON type id associated with the message.

fn full_type_id(&self) -> ExpandedNodeId

The binary type id associated with the message.

fn full_xml_type_id(&self) -> ExpandedNodeId

The XML type id associated with the message.

fn full_data_type_id(&self) -> ExpandedNodeId

The data type ID associated with the message.

impl JsonEncodable for DynamicStructure

fn encode( &self, stream: &mut JsonStreamWriter<&mut dyn Write>, ctx: &Context<'_>, ) -> EncodingResult<()>

Write the type to the provided JSON writer.

impl PartialEq for DynamicStructure

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 UaNullable for DynamicStructure

fn is_ua_null(&self) -> bool

Return true if this value is null, meaning it can be left out when being encoded in JSON and XML encodings.

impl XmlEncodable for DynamicStructure

fn encode( &self, stream: &mut XmlStreamWriter<&mut dyn Write>, ctx: &Context<'_>, ) -> EncodingResult<()>

Encode a value to an XML stream.

impl XmlType for DynamicStructure

const TAG: &'static str = "Unknown"

The static fallback tag for this type. Convenience feature, but also used in nested types.

fn tag(&self) -> &str

The XML tag name for this type.