Struct opcua_core::prelude::string::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>

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

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

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

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_options: &DecodingOptions
) -> Result<UAString, StatusCode> where
    S: Read, 

Decodes an instance from the read stream. The decoding options contains 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, Global>

impl Clone for UAString

fn clone(&self) -> UAString

Returns a copy 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<(), Error>

Formats the value using the given formatter.

impl Default for UAString

fn default() -> UAString

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UAString

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

Deserialize this value from the given Serde deserializer.

impl Display for UAString

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

Formats the value using the given formatter.

impl<'_> From<&'_ String> for UAString

fn from(value: &String) -> UAString

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl From<String> for UAString

fn from(value: String) -> UAString

Converts to this type from the input type.

impl From<UAString> for Variant

fn from(v: UAString) -> Variant

Converts to this type from the input type.

impl From<UAString> for Identifier

fn from(v: UAString) -> Identifier

Converts to this type from the input type.

impl From<UAString> for DataValue

fn from(v: UAString) -> DataValue

Converts to this type from the input type.

impl Hash for UAString

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<UAString> for UAString

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

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

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

This method tests for !=.

impl<'a, 'b> PartialEq<str> for UAString

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

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

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

This method tests for !=.

impl Serialize for UAString

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

impl StructuralEq for UAString

impl StructuralPartialEq for UAString