Struct ichen_openprotocol::Filters

pub struct Filters { /* fields omitted */ }

General authorizations to access the iChen System via Open Protocol.

See this document for details.

Methods

impl Filters

pub const None: Filters

No rights.

pub const Status: Filters

Controller status update messages.

pub const Cycle: Filters

Cycle data messages.

pub const Mold: Filters

Mold data messages.

pub const Actions: Filters

Controller action messages.

pub const Alarms: Filters

Controller alarm messages.

pub const Audit: Filters

Controller audit trail of setting changes

pub const All: Filters

Administrator rights.

All implies Status + Cycle + Mold + Actions + Alarms + Audit

pub const JobCards: Filters

MIS/MES integration: Job scheduling messages.

pub const Operators: Filters

MIS/MES integration: User authorization messages.

pub const OPCUA: Filters

Industrial bus integration: Connect via OPC UA.

pub const fn empty() -> Filters

Returns an empty set of flags

pub const fn all() -> Filters

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

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

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) -> Filters

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

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: Filters) -> bool

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

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

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

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

Inserts the specified flags in-place.

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

Removes the specified flags in-place.

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

Toggles the specified flags in-place.

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

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

impl Filters

pub fn has(self, other: Self) -> bool

Is a particular set of filters set?

Examples

use ichen_openprotocol::Filters;
let f = Filters::Status + Filters::Audit + Filters::JobCards;
assert!(f.has(Filters::Status));
assert!(f.has(Filters::JobCards));
assert!(!f.has(Filters::All));
assert!(!f.has(Filters::OPCUA));
assert!(!f.has(Filters::Mold));

Trait Implementations

impl Copy for Filters

impl Ord for Filters

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl Clone for Filters

fn clone(&self) -> Filters

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Filters> for Filters

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

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

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

This method tests for !=.

impl Extend<Filters> for Filters

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

Extends a collection with the contents of an iterator.

impl<'_> From<&'_ str> for Filters

fn from(s: &str) -> Self

Call Filters::from_str to parse a filters value from a comma-delimited string.

impl From<Filters> for String

fn from(f: Filters) -> Self

Convert filters value into a comma-delimited list.

impl Eq for Filters

impl PartialOrd<Filters> for Filters

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

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

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

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

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

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

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

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

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

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

impl Debug for Filters

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

Formats the value using the given formatter.

impl Display for Filters

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

Display filters value as comma-delimited list.

impl Add<Filters> for Filters

type Output = Self

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Turn on a particular filter.

Example

use ichen_openprotocol::Filters;
let mut f = Filters::Cycle + Filters::OPCUA;
f = f + Filters::All;
assert_eq!(Filters::All + Filters::OPCUA, f);

impl Sub<Filters> for Filters

type Output = Filters

The resulting type after applying the - operator.

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

Returns the set difference of the two sets of flags.

impl AddAssign<Filters> for Filters

fn add_assign(&mut self, other: Self)

Turn on a particular filter.

Example

use ichen_openprotocol::Filters;
let mut f = Filters::Cycle + Filters::OPCUA;
f += Filters::All;
assert_eq!(Filters::All + Filters::OPCUA, f);

impl SubAssign<Filters> for Filters

fn sub_assign(&mut self, other: Filters)

Disables all flags enabled in the set.

impl Not for Filters

type Output = Filters

The resulting type after applying the ! operator.

fn not(self) -> Filters

Returns the complement of this set of flags.

impl BitAnd<Filters> for Filters

type Output = Filters

The resulting type after applying the & operator.

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

Returns the intersection between the two sets of flags.

impl BitOr<Filters> for Filters

type Output = Filters

The resulting type after applying the | operator.

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

Returns the union of the two sets of flags.

impl BitXor<Filters> for Filters

type Output = Filters

The resulting type after applying the ^ operator.

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

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

impl BitAndAssign<Filters> for Filters

fn bitand_assign(&mut self, other: Filters)

Disables all flags disabled in the set.

impl BitOrAssign<Filters> for Filters

fn bitor_assign(&mut self, other: Filters)

Adds the set of flags.

impl BitXorAssign<Filters> for Filters

fn bitxor_assign(&mut self, other: Filters)

Toggles the set of flags.

impl Hash for Filters

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, 

Feeds a slice of this type into the given [Hasher].

impl FromIterator<Filters> for Filters

fn from_iter<T: IntoIterator<Item = Filters>>(iterator: T) -> Filters

Creates a value from an iterator.

impl FromStr for Filters

type Err = String

The associated error which can be returned from parsing.

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

Parse a comma-delimited String into a Filters values.

Filters::from_str never fails. Unmatched tokens will simply be discarded. If nothing matches, None will be returned.

Examples

use ichen_openprotocol::Filters;
let f = Filters::from_str("Hello, World, Cycle, Mold,Operators|Foo+BarXYZYXYZ=123").unwrap();
assert_eq!(Filters::Cycle + Filters::Mold, f);

impl Octal for Filters

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

Formats the value using the given formatter.

impl Binary for Filters

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

Formats the value using the given formatter.

impl LowerHex for Filters

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

Formats the value using the given formatter.

impl UpperHex for Filters

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

Formats the value using the given formatter.

impl Serialize for Filters

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Filters

fn deserialize<D>(d: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.