Struct LogicalCashUnit

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

Represents a logical cash unit, and its parameters.

Implementations

impl LogicalCashUnit

pub const fn new() -> Self

Creates a new LogicalCashUnit.

pub const fn cash_type(&self) -> CashType

Gets the CashType.

Defines the main type of cash used by this cash unit.

pub fn set_cash_type(&mut self, cash_type: CashType)

Sets the CashType.

pub fn with_cash_type(self, cash_type: CashType) -> Self

Builder function that sets the CashType.

pub const fn secondary_cash_types(&self) -> &CashTypeList

Gets the secondary CashTypeList.

Defines the additional types of cash used by this cash unit.

pub fn set_secondary_cash_types(&mut self, secondary_cash_types: CashTypeList)

Sets the secondary CashTypeList.

pub fn with_secondary_cash_types( self, secondary_cash_types: CashTypeList, ) -> Self

Builder function that sets the secondary CashType.

pub const fn number(&self) -> u32

Gets the logical number of cash unit.

Unique number of the cash unit. This number is assigned (or reassigned) on bnr_Reset() and identifies the unit along the time; therefore, it can be used to track unit changes, or uniquely reference units in method calls (DenominationItem::unit property is an example).

pub fn set_number(&mut self, number: u32)

Sets the number.

pub fn with_number(self, number: u32) -> Self

Builder function that sets the number.

pub const fn cu_kind(&self) -> CuKind

Specifies, if cash unit can dispense, deposit cash or both.

pub fn set_cu_kind(&mut self, cu_kind: CuKind)

Sets the cu_kind field, see [LCU].

pub fn with_cu_kind(self, cu_kind: CuKind) -> Self

Builder function that sets the cu_kind.

pub const fn cu_type(&self) -> CuType

Gets the type of cash unit.

pub fn set_cu_type(&mut self, cu_type: CuType)

Sets the cu_type field, see [LCU].

pub fn with_cu_type(self, cu_type: CuType) -> Self

Builder function that sets the cu_type.

pub const fn unit_id(&self) -> UnitId

Gets the UnitId.

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 initial_count(&self) -> u32

For customer purpose only; this value is initialized by the configure_cash_unit and update_cash_unit methods and not changed by the BNR.

• Type: User data.
• Max: 65535.
• Access: Read-Write (write through configure_cash_unit and update_cash_unit methods).

pub fn set_initial_count(&mut self, initial_count: u32)

Sets the initial count.

pub fn with_initial_count(self, initial_count: u32) -> Self

Builder function that sets the initial count.

pub const fn count(&self) -> u32

Actual count of bills in the logical 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 status(&self) -> u32

Cash unit status. Correspond to [PhysicalCashUnit::status].

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 extended_counters(&self) -> &ExtendedCounters

Gets the ExtendedCounters for [LCU::Deposit] and [LCU::Dispense] cash unit types.

pub fn set_extended_counters(&mut self, extended_counters: ExtendedCounters)

Sets the ExtendedCounters.

pub fn with_extended_counters(self, extended_counters: ExtendedCounters) -> Self

Builder function that sets the extended_counters.

pub const fn physical_cu_index(&self) -> UnitId

Gets the UnitId of the [PhysicalCashUnit] backing this LogicalCashUnit.

The C library uses a pointer here, but that is wildly unsafe. Use the ID instead.

pub fn set_physical_cu_index(&mut self, pcu_index: UnitId)

Sets the physical cash unit UnitId.

pub fn with_physical_cash_unit(self, pcu_index: UnitId) -> Self

Builder function that sets the physical cash unit UnitId.

impl LogicalCashUnit

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

Gets the XfsMember name.

Trait Implementations

impl Clone for LogicalCashUnit

fn clone(&self) -> LogicalCashUnit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogicalCashUnit

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

Formats the value using the given formatter.

impl Default for LogicalCashUnit

fn default() -> LogicalCashUnit

Returns the “default value” for a type.

impl Display for LogicalCashUnit

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

Formats the value using the given formatter.

impl From<&LogicalCashUnit> for XfsMember

fn from(val: &LogicalCashUnit) -> Self

Converts to this type from the input type.

impl From<&LogicalCashUnit> for XfsStruct

fn from(val: &LogicalCashUnit) -> Self

Converts to this type from the input type.

impl From<&LogicalCashUnit> for XfsValue

fn from(val: &LogicalCashUnit) -> Self

Converts to this type from the input type.

impl From<LogicalCashUnit> for XfsMember

fn from(val: LogicalCashUnit) -> Self

Converts to this type from the input type.

impl From<LogicalCashUnit> for XfsStruct

fn from(val: LogicalCashUnit) -> Self

Converts to this type from the input type.

impl From<LogicalCashUnit> for XfsValue

fn from(val: LogicalCashUnit) -> Self

Converts to this type from the input type.

impl PartialEq for LogicalCashUnit

fn eq(&self, other: &LogicalCashUnit) -> 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 TryFrom<&XfsMember> for LogicalCashUnit

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 LogicalCashUnit

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 LogicalCashUnit

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 LogicalCashUnit

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 LogicalCashUnit

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 LogicalCashUnit

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 LogicalCashUnit

impl StructuralPartialEq for LogicalCashUnit