Struct ichen_openprotocol::Operator

pub struct Operator<'a> { /* fields omitted */ }

A data structure containing information on a single user on the system.

Methods

impl<'a> Operator<'a>

pub fn id(&self) -> ID

Get the operator ID.

Examples

let opr = Operator::new(ID::from_u32(12345));
assert_eq!(12345, opr.id());

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

Examples

let opr = Operator::try_new_with_name(ID::from_u32(12345), "John")?;
assert_eq!(Some("John"), opr.name());

pub fn new(id: ID) -> Self

Create an Operator with just an ID and no name.

Examples

let opr = Operator::new(ID::from_u32(12345));
assert_eq!(12345, opr.id());
assert_eq!(None, opr.name());

pub fn try_new_with_name(id: ID, name: &'a str) -> Result<Self, String>

Create an Operator with ID and name.

Errors

Returns Err([OpenProtocolError::EmptyField]) if the operator_name field is set to an empty string or is all whitespace.

Error Examples

let result = Operator::try_new_with_name(ID::from_u32(12345), "");
assert_eq!(Err("invalid value: a non-empty, non-whitespace string required for operator name".into()), result);

Examples

let opr = Operator::try_new_with_name(ID::from_u32(12345), "John")?;
assert_eq!(12345, opr.id());
assert_eq!(Some("John"), opr.name());

Trait Implementations

impl<'a> Clone for Operator<'a>

fn clone(&self) -> Operator<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Operator<'a>

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for Operator<'a>

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

Deserialize this value from the given Serde deserializer.

impl<'a> Eq for Operator<'a>

impl<'a> Hash for Operator<'a>

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<'a> PartialEq<Operator<'a>> for Operator<'a>

fn eq(&self, other: &Operator<'a>) -> bool

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

fn ne(&self, other: &Operator<'a>) -> bool

This method tests for !=.

impl<'a> Serialize for Operator<'a>

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

Serialize this value into the given Serde serializer.

impl<'a> StructuralEq for Operator<'a>

impl<'a> StructuralPartialEq for Operator<'a>