Skip to main content

QualifiedName

Struct QualifiedName 

Source
pub struct QualifiedName {
    pub namespace_index: u16,
    pub name: UAString,
}
Expand description

An identifier for a error or condition that is associated with a value or an operation.

A name qualified by a namespace.

For JSON, the namespace_index is saved as “Uri” and MUST be a numeric value or it will not parse. This is is in accordance with OPC UA spec that says to save the index as a numeric according to rules cut and pasted from spec below:

Name The Name component of the QualifiedName.

Uri The NamespaceIndexcomponent of the QualifiedNameencoded as a JSON number. The Urifield is omitted if the NamespaceIndex equals 0. For the non-reversible form, the NamespaceUriassociated with the NamespaceIndexportion of the QualifiedNameis encoded as JSON string unless the NamespaceIndexis 1 or if NamespaceUriis unknown. In these cases, the NamespaceIndexis encoded as a JSON number.

Fields§

§namespace_index: u16

The namespace index

§name: UAString

The name.

Implementations§

Source§

impl QualifiedName

Source

pub fn new<T>(namespace_index: u16, name: T) -> QualifiedName
where T: Into<UAString>,

Create a new qualified name from namespace index and name.

Source

pub fn null() -> QualifiedName

Create a new empty QualifiedName.

Source

pub fn is_null(&self) -> bool

Return true if this is the null QualifiedName.

Source

pub fn parse(raw: &str, namespaces: &NamespaceMap) -> QualifiedName

Parse a QualifiedName from a string. Note that QualifiedName parsing is unsolvable. This does a best-effort. If parsing fails, we will capture the string as a name with namespace index 0.

Trait Implementations§

Source§

impl BinaryDecodable for QualifiedName

Source§

fn decode<S>(stream: &mut S, ctx: &Context<'_>) -> Result<QualifiedName, Error>
where S: Read + ?Sized,

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.
Source§

impl BinaryEncodable for QualifiedName

Source§

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.
Source§

fn encode<S>(&self, stream: &mut S, ctx: &Context<'_>) -> Result<(), Error>
where S: Write + ?Sized,

Encodes the instance to the write stream.
Source§

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.
Source§

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.
Source§

impl Clone for QualifiedName

Source§

fn clone(&self) -> QualifiedName

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QualifiedName

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QualifiedName

Source§

fn default() -> QualifiedName

Returns the “default value” for a type. Read more
Source§

impl Display for QualifiedName

Source§

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

Formats the value using the given formatter. Read more
Source§

impl From<&String> for QualifiedName

Source§

fn from(value: &String) -> QualifiedName

Converts to this type from the input type.
Source§

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

Source§

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

Converts to this type from the input type.
Source§

impl From<QualifiedName> for DataValue

Source§

fn from(v: QualifiedName) -> DataValue

Converts to this type from the input type.
Source§

impl From<String> for QualifiedName

Source§

fn from(value: String) -> QualifiedName

Converts to this type from the input type.
Source§

impl Hash for QualifiedName

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl IntoVariant for Box<QualifiedName>

Source§

fn into_variant(self) -> Variant

Convert self into a variant.
Source§

impl IntoVariant for QualifiedName

Source§

fn into_variant(self) -> Variant

Convert self into a variant.
Source§

impl JsonDecodable for QualifiedName

Source§

fn decode( stream: &mut JsonStreamReader<&mut dyn Read>, ctx: &Context<'_>, ) -> Result<QualifiedName, Error>

Decode Self from a JSON stream.
Source§

impl JsonEncodable for QualifiedName

Source§

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

Write the type to the provided JSON writer.
Source§

impl PartialEq for QualifiedName

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl TryFromVariant for QualifiedName

Source§

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

Try to cast the given variant to this type.
Source§

impl UaNullable for QualifiedName

Source§

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.
Source§

impl VariantType for QualifiedName

Source§

fn variant_type_id() -> VariantScalarTypeId

The variant kind this type will be represented as.
Source§

impl XmlDecodable for QualifiedName

Source§

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

Decode a value from an XML stream.
Source§

impl XmlEncodable for QualifiedName

Source§

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

Encode a value to an XML stream.
Source§

impl XmlType for QualifiedName

Source§

const TAG: &'static str = "QualifiedName"

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

fn tag(&self) -> &str

The XML tag name for this type.
Source§

impl Eq for QualifiedName

Source§

impl StructuralPartialEq for QualifiedName

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> EventField for T
where T: IntoVariant + Clone,

Source§

fn get_value( &self, attribute_id: AttributeId, index_range: &NumericRange, remaining_path: &[QualifiedName], ) -> Variant

Get the variant representation of this field, using the given index range. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoAnyArc for T
where T: Send + Sync + 'static,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Upcast to Arc<dyn Any>.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more