Struct PhysicalCashUnit

#[repr(C)]
pub struct PhysicalCashUnit { /* private fields */ }

Represents a XFS physical cash unit and its parameters.

Implementations

impl PhysicalCashUnit

pub const fn new() -> Self

Creates a new PhysicalCashUnit.

pub const fn name(&self) -> &PcuName

Gets the PcuName.

Name of the physical location in the BNR where this cash unit is installed.

pub fn set_name(&mut self, name: PcuName)

Sets the PcuName.

pub fn with_name(self, name: PcuName) -> Self

Builder function that sets the PcuName.

pub const fn unit_id(&self) -> &UnitId

Gets the UnitId.

Physical cash unit ID. Corresponds to the BNR Module Serial Number (MSN).

pub fn set_unit_id(&mut self, unit_id: UnitId)

Sets the UnitId.

pub fn with_unit_id(self, unit_id: UnitId) -> Self

Builder function that sets the UnitId.

pub const fn count(&self) -> u32

Gets the count.

Actual count of bills in the physical cash unit.

• Type: One Shot.
• Max: 65535.
• Access:
  • Bundler and Recycler Physical Cash Units - Read-Only
  • Cashbox and Loader Physical Cash Units - Read-Write (write through configure_cash_unit and update_cash_unit methods).

pub fn set_count(&mut self, count: u32)

Sets the count.

pub fn with_count(self, count: u32) -> Self

Builder function that sets the count.

pub const fn threshold(&self) -> Threshold

Gets the Threshold.

Defines limits to determine threshold_status.

pub fn set_threshold(&mut self, threshold: Threshold)

Sets the Threshold.

pub fn with_threshold(self, threshold: Threshold) -> Self

Builder function that sets the Threshold.

pub const fn status(&self) -> u32

Gets the status.

Status of the physical cash unit.

pub fn set_status(&mut self, status: u32)

Sets the status.

pub fn with_status(self, status: u32) -> Self

Builder function that sets the status.

pub const fn threshold_status(&self) -> ThresholdStatus

Gets the ThresholdStatus.

ThresholdStatus of the physical cash unit.

pub fn set_threshold_status(&mut self, status: ThresholdStatus)

Sets the ThresholdStatus.

pub fn with_threshold_status(self, status: ThresholdStatus) -> Self

Builder function that sets the ThresholdStatus.

pub const fn threshold_mode(&self) -> ThresholdMode

Gets the ThresholdMode.

Defines how threshold_status is determined.

pub fn set_threshold_mode(&mut self, mode: ThresholdMode)

Sets the ThresholdMode.

pub fn with_threshold_mode(self, mode: ThresholdMode) -> Self

Builder function that sets the ThresholdMode.

pub const fn lock(&self) -> bool

Gets the lock.

Enables or disables the physical cash unit.

pub fn set_lock(&mut self, lock: bool)

Sets the lock.

pub fn with_lock(self, lock: bool) -> Self

Builder function that sets the lock.

impl PhysicalCashUnit

pub const fn xfs_name() -> &'static str

Gets the XfsMember name.

Trait Implementations

impl Clone for PhysicalCashUnit

fn clone(&self) -> PhysicalCashUnit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PhysicalCashUnit

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

Formats the value using the given formatter.

impl Default for PhysicalCashUnit

fn default() -> PhysicalCashUnit

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PhysicalCashUnit

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PhysicalCashUnit

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

Formats the value using the given formatter.

impl From<&PhysicalCashUnit> for XfsMember

fn from(val: &PhysicalCashUnit) -> Self

Converts to this type from the input type.

impl From<&PhysicalCashUnit> for XfsStruct

fn from(val: &PhysicalCashUnit) -> Self

Converts to this type from the input type.

impl From<&PhysicalCashUnit> for XfsValue

fn from(val: &PhysicalCashUnit) -> Self

Converts to this type from the input type.

impl From<PhysicalCashUnit> for XfsMember

fn from(val: PhysicalCashUnit) -> Self

Converts to this type from the input type.

impl From<PhysicalCashUnit> for XfsStruct

fn from(val: PhysicalCashUnit) -> Self

Converts to this type from the input type.

impl From<PhysicalCashUnit> for XfsValue

fn from(val: PhysicalCashUnit) -> Self

Converts to this type from the input type.

impl PartialEq for PhysicalCashUnit

fn eq(&self, other: &PhysicalCashUnit) -> 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 Serialize for PhysicalCashUnit

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&XfsMember> for PhysicalCashUnit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &XfsMember) -> Result<Self>

Performs the conversion.

impl TryFrom<&XfsStruct> for PhysicalCashUnit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &XfsStruct) -> Result<Self>

Performs the conversion.

impl TryFrom<&XfsValue> for PhysicalCashUnit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: &XfsValue) -> Result<Self>

Performs the conversion.

impl TryFrom<XfsMember> for PhysicalCashUnit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: XfsMember) -> Result<Self>

Performs the conversion.

impl TryFrom<XfsStruct> for PhysicalCashUnit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: XfsStruct) -> Result<Self>

Performs the conversion.

impl TryFrom<XfsValue> for PhysicalCashUnit

type Error = Error

The type returned in the event of a conversion error.

fn try_from(val: XfsValue) -> Result<Self>

Performs the conversion.

impl Copy for PhysicalCashUnit

impl StructuralPartialEq for PhysicalCashUnit