Struct opcua_server::prelude::WriteMask

pub struct WriteMask { /* private fields */ }

Implementations

impl WriteMask

pub const ACCESS_LEVEL: WriteMask = Self{ bits: 1,}

Indicates if the AccessLevel Attribute is writable.

pub const ARRAY_DIMENSTIONS: WriteMask = Self{ bits: 1 << 1,}

Indicates if the ArrayDimensions Attribute is writable.

pub const BROWSE_NAME: WriteMask = Self{ bits: 1 << 2,}

Indicates if the BrowseName Attribute is writable.

pub const CONTAINS_NO_LOOPS: WriteMask = Self{ bits: 1 << 3,}

Indicates if the ContainsNoLoops Attribute is writable.

pub const DATA_TYPE: WriteMask = Self{ bits: 1 << 4,}

Indicates if the DataType Attribute is writable.

pub const DESCRIPTION: WriteMask = Self{ bits: 1 << 5,}

Indicates if the Description Attribute is writable.

pub const DISPLAY_NAME: WriteMask = Self{ bits: 1 << 6,}

Indicates if the DisplayName Attribute is writable.

pub const EVENT_NOTIFIER: WriteMask = Self{ bits: 1 << 7,}

Indicates if the EventNotifier Attribute is writable.

pub const EXECUTABLE: WriteMask = Self{ bits: 1 << 8,}

Indicates if the Executable Attribute is writable.

pub const HISTORIZING: WriteMask = Self{ bits: 1 << 9,}

Indicates if the Historizing Attribute is writable.

pub const INVERSE_NAME: WriteMask = Self{ bits: 1 << 10,}

Indicates if the InverseName Attribute is writable.

pub const IS_ABSTRACT: WriteMask = Self{ bits: 1 << 11,}

Indicates if the IsAbstract Attribute is writable.

pub const MINIMUM_SAMPLING_INTERVAL: WriteMask = Self{ bits: 1 << 12,}

Indicates if the MinimumSamplingInterval Attribute is writable.

pub const NODE_CLASS: WriteMask = Self{ bits: 1 << 13,}

Indicates if the NodeClass Attribute is writable.

pub const NODE_ID: WriteMask = Self{ bits: 1 << 14,}

Indicates if the NodeId Attribute is writable.

pub const SYMMETRIC: WriteMask = Self{ bits: 1 << 15,}

Indicates if the Symmetric Attribute is writable.

pub const USER_ACCESS_LEVEL: WriteMask = Self{ bits: 1 << 16,}

Indicates if the UserAccessLevel Attribute is writable.

pub const USER_EXECUTABLE: WriteMask = Self{ bits: 1 << 17,}

Indicates if the UserExecutable Attribute is writable.

pub const USER_WRITE_MASK: WriteMask = Self{ bits: 1 << 18,}

Indicates if the UserWriteMask Attribute is writable.

pub const VALUE_RANK: WriteMask = Self{ bits: 1 << 19,}

Indicates if the ValueRank Attribute is writable.

pub const WRITE_MASK: WriteMask = Self{ bits: 1 << 20,}

Indicates if the WriteMask Attribute is writable.

pub const VALUE_FOR_VARIABLE_TYPE: WriteMask = Self{ bits: 1 << 21,}

Indicates if the Value Attribute is writable for a VariableType. It does not apply for Variables since this is handled by the AccessLevel and UserAccessLevel Attributes for the Variable. For Variables this bit shall be set to 0.

pub const fn empty() -> WriteMask

Returns an empty set of flags.

pub const fn all() -> WriteMask

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub const fn from_bits(bits: u32) -> Option<WriteMask>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> WriteMask

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> WriteMask

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

Safety

The caller of the bitflags! macro can chose to allow or disallow extra bits for their bitflags type.

The caller of from_bits_unchecked() has to ensure that all bits correspond to a defined flag or that extra bits are valid for this bitflags type.

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: WriteMask) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: WriteMask) -> bool

Returns true if all of the flags in other are contained within self.

pub fn insert(&mut self, other: WriteMask)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: WriteMask)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: WriteMask)

Toggles the specified flags in-place.

pub fn set(&mut self, other: WriteMask, value: bool)

Inserts or removes the specified flags depending on the passed value.

pub const fn intersection(self, other: WriteMask) -> WriteMask

Returns the intersection between the flags in self and other.

Specifically, the returned set contains only the flags which are present in both self and other.

This is equivalent to using the & operator (e.g. ops::BitAnd), as in flags & other.

pub const fn union(self, other: WriteMask) -> WriteMask

Returns the union of between the flags in self and other.

Specifically, the returned set contains all flags which are present in either self or other, including any which are present in both (see Self::symmetric_difference if that is undesirable).

This is equivalent to using the | operator (e.g. ops::BitOr), as in flags | other.

pub const fn difference(self, other: WriteMask) -> WriteMask

Returns the difference between the flags in self and other.

Specifically, the returned set contains all flags present in self, except for the ones present in other.

It is also conceptually equivalent to the “bit-clear” operation: flags & !other (and this syntax is also supported).

This is equivalent to using the - operator (e.g. ops::Sub), as in flags - other.

pub const fn symmetric_difference(self, other: WriteMask) -> WriteMask

Returns the symmetric difference between the flags in self and other.

Specifically, the returned set contains the flags present which are present in self or other, but that are not present in both. Equivalently, it contains the flags present in exactly one of the sets self and other.

This is equivalent to using the ^ operator (e.g. ops::BitXor), as in flags ^ other.

pub const fn complement(self) -> WriteMask

Returns the complement of this set of flags.

Specifically, the returned set contains all the flags which are not set in self, but which are allowed for this type.

Alternatively, it can be thought of as the set difference between Self::all() and self (e.g. Self::all() - self)

This is equivalent to using the ! operator (e.g. ops::Not), as in !flags.

Trait Implementations

impl Binary for WriteMask

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

Formats the value using the given formatter.

impl BitAnd<WriteMask> for WriteMask

fn bitand(self, other: WriteMask) -> WriteMask

Returns the intersection between the two sets of flags.

type Output = WriteMask

The resulting type after applying the & operator.

impl BitAndAssign<WriteMask> for WriteMask

fn bitand_assign(&mut self, other: WriteMask)

Disables all flags disabled in the set.

impl BitOr<WriteMask> for WriteMask

fn bitor(self, other: WriteMask) -> WriteMask

Returns the union of the two sets of flags.

type Output = WriteMask

The resulting type after applying the | operator.

impl BitOrAssign<WriteMask> for WriteMask

fn bitor_assign(&mut self, other: WriteMask)

Adds the set of flags.

impl BitXor<WriteMask> for WriteMask

fn bitxor(self, other: WriteMask) -> WriteMask

Returns the left flags, but with all the right flags toggled.

type Output = WriteMask

The resulting type after applying the ^ operator.

impl BitXorAssign<WriteMask> for WriteMask

fn bitxor_assign(&mut self, other: WriteMask)

Toggles the set of flags.

impl Clone for WriteMask

fn clone(&self) -> WriteMask

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WriteMask

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

Formats the value using the given formatter.

impl Extend<WriteMask> for WriteMask

fn extend<T>(&mut self, iterator: T)where
    T: IntoIterator<Item = WriteMask>,

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<WriteMask> for WriteMask

fn from_iter<T>(iterator: T) -> WriteMaskwhere
    T: IntoIterator<Item = WriteMask>,

Creates a value from an iterator.

impl Hash for WriteMask

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl LowerHex for WriteMask

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

Formats the value using the given formatter.

impl Not for WriteMask

fn not(self) -> WriteMask

Returns the complement of this set of flags.

type Output = WriteMask

The resulting type after applying the ! operator.

impl Octal for WriteMask

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

Formats the value using the given formatter.

impl Ord for WriteMask

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<WriteMask> for WriteMask

fn eq(&self, other: &WriteMask) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<WriteMask> for WriteMask

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Sub<WriteMask> for WriteMask

fn sub(self, other: WriteMask) -> WriteMask

Returns the set difference of the two sets of flags.

type Output = WriteMask

The resulting type after applying the - operator.

impl SubAssign<WriteMask> for WriteMask

fn sub_assign(&mut self, other: WriteMask)

Disables all flags enabled in the set.

impl UpperHex for WriteMask

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

Formats the value using the given formatter.

impl Copy for WriteMask

impl Eq for WriteMask

impl StructuralEq for WriteMask

impl StructuralPartialEq for WriteMask