Struct ichen_openprotocol::Operator

pub struct Operator<'a> {
    pub operator_id: ID,
    pub operator_name: Option<&'a str>,
}

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

Fields

operator_id: ID

Unique user ID, which cannot be zero.

operator_name: Option<&'a str>

Name of the user.

Methods

impl<'a> Operator<'a>

pub fn new(id: ID) -> Self

Create an Operator with just an ID and no name.

Examples

let op = Operator::new(ID::from(12345));
assert_eq!(12345, u32::from(op.operator_id));
assert_eq!(None, op.operator_name);

pub fn new_with_name(id: ID, name: &'a str) -> Self

Create an Operator with ID and name.

Examples

let op = Operator::new_with_name(ID::from(12345), "John");
assert_eq!(12345, u32::from(op.operator_id));
assert_eq!(Some("John"), op.operator_name);

pub fn validate(&self) -> Result<'static, ()>

Validate the data structure.

Errors

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

Examples

let op = Operator::new_with_name(ID::from(12345), "John");
assert_eq!(r#"Err(EmptyField("operator_name"))"#, format!("{:?}", op.validate()));

Trait Implementations

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

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

Formats the value using the given formatter.

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<'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.