Struct String 

pub struct String(/* private fields */);

Wrapper for UA_String from open62541_sys.

This owns the wrapped data. When the wrapper is dropped, the inner value is cleaned up with UA_clear() to release dynamically allocated memory held by the value.

Implementations

impl String

pub fn new(s: &str) -> Result<Self, Error>

Creates string from string slice.

Errors

The string must not contain any NUL bytes.

pub fn null() -> Self

Creates an invalid null string (as defined by OPC UA).

pub fn is_null(&self) -> bool

Checks if string is null and invalid.

The null state is defined by OPC UA. It is a third state which is distinct from empty and regular (non-empty) strings.

pub fn is_empty(&self) -> bool

Checks if string is empty.

pub fn as_bytes(&self) -> Option<&[u8]>

Returns string contents as byte slice.

This may return None when the string itself is invalid (as defined by OPC UA).

pub fn as_str(&self) -> Option<&str>

Returns string contents as string slice.

This may return None when the string itself is invalid (as defined by OPC UA) or when it is not valid Unicode (UTF-8).

pub fn into_byte_string(self) -> ByteString

Converts string into byte string.

This is lossless because the underlying types of OPC UA strings and byte strings are exactly the same, only with different semantics.

Trait Implementations

impl Clone for String

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataType for String

type Inner = UA_String

Inner type.

fn data_type() -> *const UA_DataType

Gets open62541 data type record.

unsafe fn from_raw(src: Self::Inner) -> Self

Creates wrapper by taking ownership of value.

fn into_raw(self) -> Self::Inner

Gives up ownership and returns value.

fn type_name() -> &'static str

Gets data type name.

fn init() -> Self

Creates wrapper initialized with defaults.

fn raw_ref(src: &Self::Inner) -> &Self

Creates wrapper reference from value.

fn raw_mut(src: &mut Self::Inner) -> &mut Self

Creates mutable wrapper reference from value.

fn clone_raw(src: &Self::Inner) -> Self

Creates wrapper by cloning value from src.

fn take_raw(src: &mut Self::Inner) -> Self

Creates wrapper by moving value from src.

fn clone_into_raw(&self, dst: &mut Self::Inner)

Clones value into dst.

fn move_into_raw(self, dst: &mut Self::Inner)

Moves value into dst, giving up ownership.

fn leak_into_raw(self) -> *mut Self::Inner

Leaks wrapped value onto the heap.

unsafe fn to_raw_copy(this: &Self) -> Self::Inner

Creates copy without giving up ownership.

unsafe fn as_ref(&self) -> &Self::Inner

Returns shared reference to value.

unsafe fn as_mut(&mut self) -> &mut Self::Inner

Returns exclusive reference to value.

unsafe fn as_ptr(&self) -> *const Self::Inner

Returns const pointer to value.

unsafe fn as_mut_ptr(&mut self) -> *mut Self::Inner

Returns mutable pointer to value.

fn print(this: &Self) -> Option<String>

Prints value to string.

fn order(this: &Self, other: &Self) -> UA_Order

Compares value to other.

impl Debug for String

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

Formats the value using the given formatter.

impl Display for String

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

Creates string from String value.

Examples

use open62541::{ua, DataType as _};

let node_id = ua::String::init();
let str = node_id.to_string();

assert_eq!(str, "");

impl Drop for String

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl Eq for String

impl Ord for String

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for String

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for String

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Send for String

impl Serialize for String

Available on crate feature serde only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sync for String