Struct NodeId 

pub struct NodeId {
    pub namespace: u16,
    pub identifier: Identifier,
}

An identifier for a node in the address space of an OPC UA Server.

Fields

namespace: u16

The index for a namespace

identifier: Identifier

The identifier for the node in the address space

Implementations

impl NodeId

pub fn new<T>(namespace: u16, value: T) -> NodeId

where T: Into<Identifier>,

Constructs a new NodeId from anything that can be turned into Identifier u32, Guid, ByteString or String

pub fn root_folder_id() -> NodeId

Returns the node id for the root folder.

pub fn objects_folder_id() -> NodeId

Returns the node id for the objects folder.

pub fn types_folder_id() -> NodeId

Returns the node id for the types folder.

pub fn views_folder_id() -> NodeId

Returns the node id for the views folder.

pub fn is_null(&self) -> bool

Test if the node id is null, i.e. 0 namespace and 0 identifier

pub fn null() -> NodeId

Returns a null node id

pub fn next_numeric(namespace: u16) -> NodeId

Creates a numeric node id with an id incrementing up from 1000

pub fn as_object_id(&self) -> Result<ObjectId, NodeIdError>

Extracts an ObjectId from a node id, providing the node id holds an object id

pub fn as_variable_id(&self) -> Result<VariableId, NodeIdError>

Try to convert this to a builtin variable ID.

pub fn as_reference_type_id(&self) -> Result<ReferenceTypeId, NodeIdError>

Try to convert this to a builtin reference type ID.

pub fn as_data_type_id(&self) -> Result<DataTypeId, NodeIdError>

Try to convert this to a builtin data type ID.

pub fn as_method_id(&self) -> Result<MethodId, NodeIdError>

Try to convert this to a builtin method ID.

pub fn is_numeric(&self) -> bool

Test if the node id is numeric

pub fn is_string(&self) -> bool

Test if the node id is a string

pub fn is_guid(&self) -> bool

Test if the node id is a guid

pub fn is_byte_string(&self) -> bool

Test if the node id us a byte string

pub fn as_u32(&self) -> Option<u32>

Get the numeric value of this node ID if it is numeric.

Trait Implementations

impl BinaryDecodable for NodeId

fn decode<S: Read + ?Sized>( stream: &mut S, ctx: &Context<'_>, ) -> EncodingResult<Self>

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.

impl BinaryEncodable for NodeId

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 NodeId

fn clone(&self) -> NodeId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NodeId

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

Formats the value using the given formatter.

impl Default for NodeId

fn default() -> Self

Returns the “default value” for a type.

impl Display for NodeId

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

Formats the value using the given formatter.

impl<T> Equivalent<NodeId> for NodeIdRef<T>

where NodeIdRef<T>: PartialEq<NodeId>,

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

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

impl<'a> From<&'a DataTypeId> for NodeId

fn from(r: &'a DataTypeId) -> Self

Converts to this type from the input type.

impl<'a> From<&'a MethodId> for NodeId

fn from(r: &'a MethodId) -> Self

Converts to this type from the input type.

impl From<&NodeId> for ExpandedNodeId

fn from(value: &NodeId) -> Self

Converts to this type from the input type.

impl From<&NodeId> for NodeId

fn from(v: &NodeId) -> Self

Converts to this type from the input type.

impl<'a> From<&'a NodeId> for NodeIdRef<&'a Identifier>

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

Converts to this type from the input type.

impl<'a> From<&'a NodeId> for ReadValueId

fn from(node_id: &'a NodeId) -> Self

Converts to this type from the input type.

impl<'a> From<&'a ObjectId> for NodeId

fn from(r: &'a ObjectId) -> Self

Converts to this type from the input type.

impl<'a> From<&'a ObjectTypeId> for NodeId

fn from(r: &'a ObjectTypeId) -> Self

Converts to this type from the input type.

impl<'a> From<&'a ReferenceTypeId> for NodeId

fn from(r: &'a ReferenceTypeId) -> Self

Converts to this type from the input type.

impl<'a> From<&'a VariableId> for NodeId

fn from(r: &'a VariableId) -> Self

Converts to this type from the input type.

impl<'a> From<&'a VariableTypeId> for NodeId

fn from(r: &'a VariableTypeId) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> From<(u16, &'a str)> for NodeId

fn from(v: (u16, &'a str)) -> Self

Converts to this type from the input type.

impl From<(u16, ByteString)> for NodeId

fn from(v: (u16, ByteString)) -> Self

Converts to this type from the input type.

impl From<(u16, Guid)> for NodeId

fn from(v: (u16, Guid)) -> Self

Converts to this type from the input type.

impl From<(u16, UAString)> for NodeId

fn from(v: (u16, UAString)) -> Self

Converts to this type from the input type.

impl From<(u16, u32)> for NodeId

fn from(v: (u16, u32)) -> Self

Converts to this type from the input type.

impl From<ByteString> for NodeId

fn from(value: ByteString) -> Self

Converts to this type from the input type.

impl From<DataTypeId> for NodeId

fn from(r: DataTypeId) -> Self

Converts to this type from the input type.

impl From<Guid> for NodeId

fn from(value: Guid) -> Self

Converts to this type from the input type.

impl From<MethodId> for NodeId

fn from(r: MethodId) -> Self

Converts to this type from the input type.

impl From<NodeId> for DataValue

fn from(v: NodeId) -> Self

Converts to this type from the input type.

impl From<NodeId> for ExpandedNodeId

fn from(v: NodeId) -> Self

Converts to this type from the input type.

impl From<NodeId> for LiteralOperand

fn from(v: NodeId) -> Self

Converts to this type from the input type.

impl From<NodeId> for MonitoredItemCreateRequest

fn from(value: NodeId) -> Self

Converts to this type from the input type.

impl From<NodeId> for ReadValueId

fn from(node_id: NodeId) -> Self

Converts to this type from the input type.

impl From<NodeId> for String

fn from(value: NodeId) -> Self

Converts to this type from the input type.

impl From<ObjectId> for NodeId

fn from(r: ObjectId) -> Self

Converts to this type from the input type.

impl From<ObjectTypeId> for NodeId

fn from(r: ObjectTypeId) -> Self

Converts to this type from the input type.

impl From<ReferenceTypeId> for NodeId

fn from(r: ReferenceTypeId) -> 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<VariableId> for NodeId

fn from(r: VariableId) -> Self

Converts to this type from the input type.

impl From<VariableTypeId> for NodeId

fn from(r: VariableTypeId) -> Self

Converts to this type from the input type.

impl From<u32> for NodeId

fn from(value: u32) -> Self

Converts to this type from the input type.

impl FromStr for NodeId

type Err = StatusCode

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for NodeId

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<'a> IntoNodeIdRef<'a> for &'a NodeId

type TIdentifier = &'a Identifier

The inner identifier type.

fn into_node_id_ref(self) -> NodeIdRef<Self::TIdentifier>

Get a reference to this as a NodeIdRef.

impl IntoVariant for Box<NodeId>

fn into_variant(self) -> Variant

Convert self into a variant.

impl IntoVariant for NodeId

fn into_variant(self) -> Variant

Convert self into a variant.

impl JsonDecodable for NodeId

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

Decode Self from a JSON stream.

impl JsonEncodable for NodeId

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

Write the type to the provided JSON writer.

impl<T> PartialEq<&NodeId> for NodeIdRef<T>

where T: PartialEq<Identifier>,

fn eq(&self, other: &&NodeId) -> 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<(u16, &[u8])> for NodeId

fn eq(&self, other: &(u16, &[u8])) -> 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<(u16, &[u8; 16])> for NodeId

fn eq(&self, other: &(u16, &[u8; 16])) -> 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<(u16, &str)> for NodeId

fn eq(&self, other: &(u16, &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<(u16, u32)> for NodeId

fn eq(&self, other: &(u16, u32)) -> 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<DataTypeId> for NodeId

fn eq(&self, other: &DataTypeId) -> 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<T> PartialEq<NodeId> for NodeIdRef<T>

where T: PartialEq<Identifier>,

fn eq(&self, other: &NodeId) -> 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<T> PartialEq<NodeIdRef<T>> for &NodeId

where T: PartialEq<Identifier>,

fn eq(&self, other: &NodeIdRef<T>) -> 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<T> PartialEq<NodeIdRef<T>> for NodeId

where T: PartialEq<Identifier>,

fn eq(&self, other: &NodeIdRef<T>) -> 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<ObjectId> for NodeId

fn eq(&self, other: &ObjectId) -> 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<ObjectTypeId> for NodeId

fn eq(&self, other: &ObjectTypeId) -> 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<ReferenceTypeId> for NodeId

fn eq(&self, other: &ReferenceTypeId) -> 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<VariableId> for NodeId

fn eq(&self, other: &VariableId) -> 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<VariableTypeId> for NodeId

fn eq(&self, other: &VariableTypeId) -> 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 NodeId

fn eq(&self, other: &NodeId) -> 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 TryFrom<&NodeId> for VariantScalarTypeId

type Error = NodeIdError

The type returned in the event of a conversion error.

fn try_from(value: &NodeId) -> Result<Self, NodeIdError>

Performs the conversion.

impl TryFrom<&NodeId> for VariantTypeId<'_>

type Error = NodeIdError

The type returned in the event of a conversion error.

fn try_from(value: &NodeId) -> Result<Self, NodeIdError>

Performs the conversion.

impl TryFromVariant for NodeId

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

Try to cast the given variant to this type.

impl UaNullable for NodeId

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 NodeId

fn variant_type_id() -> VariantScalarTypeId

The variant kind this type will be represented as.

impl XmlDecodable for NodeId

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

where Self: Sized,

Decode a value from an XML stream.

impl XmlEncodable for NodeId

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

Encode a value to an XML stream.

impl XmlType for NodeId

const TAG: &'static str = "NodeId"

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 NodeId

impl StructuralPartialEq for NodeId