Struct UAString

pub struct UAString { /* private fields */ }

To avoid naming conflict hell, the OPC UA String type is typed UAString so it does not collide with the Rust String.

A string contains UTF-8 encoded characters or a null value. A null value is distinct from being an empty string so internally, the code maintains that distinction by holding the value as an Option<String>.

Implementations

impl UAString

pub fn value(&self) -> &Option<String>

Get the inner raw value.

pub fn set_value(&mut self, value: Option<String>)

Set the inner value.

pub fn is_empty(&self) -> bool

Returns true if the string is null or empty, false otherwise

pub fn len(&self) -> isize

Returns the length of the string in bytes or -1 for null.

pub fn null() -> UAString

Create a null string (not the same as an empty string).

pub fn is_null(&self) -> bool

Test if the string is null.

pub fn substring(&self, min: usize, max: usize) -> Result<UAString, OutOfRange>

This function is meant for use with NumericRange. It creates a substring from this string from min up to and inclusive of max. Note that min must have an index within the string but max is allowed to be beyond the end in which case the remainder of the string is returned (see docs for NumericRange).

Trait Implementations

impl AsRef<str> for UAString

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for UAString

fn clone(&self) -> UAString

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for UAString

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

Formats the value using the given formatter.

impl Default for UAString

fn default() -> Self

Returns the “default value” for a type.

impl Display for UAString

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

Formats the value using the given formatter.

impl From<&String> for UAString

fn from(value: &String) -> Self

Converts to this type from the input type.

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

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl From<Option<String>> for UAString

fn from(value: Option<String>) -> Self

Converts to this type from the input type.

impl From<String> for UAString

fn from(value: String) -> Self

Converts to this type from the input type.

impl From<UAString> for DataValue

fn from(v: UAString) -> Self

Converts to this type from the input type.

impl From<UAString> for Identifier

fn from(v: UAString) -> Self

Converts to this type from the input type.

impl From<UAString> for NodeId

fn from(value: UAString) -> Self

Converts to this type from the input type.

impl From<UAString> for String

fn from(value: UAString) -> Self

Converts to this type from the input type.

impl From<UAString> for XmlElement

fn from(value: UAString) -> Self

Converts to this type from the input type.

impl Hash for UAString

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 IntoVariant for UAString

fn into_variant(self) -> Variant

Convert self into a variant.

impl JsonDecodable for UAString

fn decode( stream: &mut JsonStreamReader<&mut dyn Read>, _ctx: &Context<'_>, ) -> EncodingResult<Self>

Decode Self from a JSON stream.

impl JsonEncodable for UAString

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

Write the type to the provided JSON writer.

impl PartialEq<str> for UAString

fn eq(&self, other: &str) -> 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 PartialEq for UAString

fn eq(&self, other: &UAString) -> 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 SimpleBinaryDecodable for UAString

fn decode<S: Read + ?Sized>( stream: &mut S, decoding_options: &DecodingOptions, ) -> EncodingResult<Self>

Decode Self from the byte stream.

impl SimpleBinaryEncodable for UAString

fn byte_len(&self) -> usize

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) -> EncodingResult<()>

Encodes the instance to the write stream.

fn encode_to_vec(&self) -> 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 TryFromVariant for UAString

fn try_from_variant(v: Variant) -> Result<Self, Error>

Try to cast the given variant to this type.

impl UaNullable for UAString

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 VariantType for UAString

fn variant_type_id() -> VariantScalarTypeId

The variant kind this type will be represented as.

impl XmlDecodable for UAString

fn decode( read: &mut XmlStreamReader<&mut dyn Read>, _context: &Context<'_>, ) -> Result<Self, Error>

Decode a value from an XML stream.

impl XmlEncodable for UAString

fn encode( &self, writer: &mut XmlStreamWriter<&mut dyn Write>, _ctx: &Context<'_>, ) -> Result<(), Error>

Encode a value to an XML stream.

impl XmlType for UAString

const TAG: &'static str = "String"

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.

impl Eq for UAString

impl StructuralPartialEq for UAString