Struct ebds::note_retrieved::NoteRetrievedEvent

pub struct NoteRetrievedEvent { /* private fields */ }

Note Retrieved - Event (Subtype 0x0B)

If the functionality has been enabled, the device will send out a message each time the note is removed after a return/reject.

The Note Retrieved Event is formatted as follows:

Name	STX	LEN	CTRL	Subtype	Data 0	Data 1	Data 2	Data 3	Data 4	Data 5	Event	ETX	CHK
Byte	0	1	2	3	4	5	6	7	8	9	10	11	12
Value	0x02	0x0D	0x7n	0x0B	nn	nn	nn	nn	nn	nn	0x7F	0x03	zz

The 0x7F for the `Event byte signifies that the note has been removed by the user.

Implementations

impl NoteRetrievedEvent

pub fn new() -> Self

pub fn retrieved_event(&self) -> u8

Trait Implementations

impl Clone for NoteRetrievedEvent

fn clone(&self) -> NoteRetrievedEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NoteRetrievedEvent

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

Formats the value using the given formatter.

impl Default for NoteRetrievedEvent

fn default() -> NoteRetrievedEvent

Returns the “default value” for a type.

impl Display for NoteRetrievedEvent

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

Formats the value using the given formatter.

impl ExtendedCommandOps for NoteRetrievedEvent

fn extended_command(&self) -> ExtendedCommand

Get the extended command sub-type

fn set_extended_command(&mut self, ext_cmd: ExtendedCommand)

Set the extended command sub-type

impl From<&NoteRetrievedEvent> for OmnibusReply

fn from(reply: &NoteRetrievedEvent) -> Self

Converts to this type from the input type.

impl From<NoteRetrievedEvent> for OmnibusReply

fn from(reply: NoteRetrievedEvent) -> Self

Converts to this type from the input type.

impl MessageOps for NoteRetrievedEvent

fn buf(&self) -> &[u8]

Get a reference to the message buffer.

fn buf_mut(&mut self) -> &mut [u8]

Get a mutable reference to the message buffer.

fn init(&mut self)

Initialize common message fields

fn len(&self) -> usize

Get the length of the entire message.

fn is_empty(&self) -> bool

Gets whether the message buffer is empty (all zeros)

fn data_len(&self) -> usize

Get the length of data bytes.

fn etx_index(&self) -> usize

Get the ETX index.

fn chk_index(&self) -> usize

Get the checksum index.

fn acknak(&self) -> AckNak

Get the ACKNAK control field.

fn set_acknak(&mut self, acknak: AckNak)

Set the ACKNAK control field.

fn switch_acknak(&mut self)

Switches the current ACKNAK control field value.

fn device_type(&self) -> DeviceType

Get the device type control field.

fn set_device_type(&mut self, device_type: DeviceType)

Set the device type control field

fn message_type(&self) -> MessageType

Get the message type control field

fn set_message_type(&mut self, message_type: MessageType)

Set the message type control field

fn checksum(&self) -> u8

Get the current checksum value

fn checksum_bytes(&self) -> &[u8]

fn calculate_checksum(&mut self) -> u8

Calculate the message checksum

fn validate_checksum(&self) -> Result<()>

Validate the message checksum

fn as_bytes(&mut self) -> &[u8]

Get the message as a byte buffer

fn as_bytes_mut(&mut self) -> &mut [u8]

Get a mutable reference to the byte buffer

fn as_bytes_unchecked(&self) -> &[u8]

Get the message as a byte buffer

fn from_buf(&mut self, buf: &[u8]) -> Result<()>

Deserializes a message type from a byte buffer.

impl OmnibusReplyOps for NoteRetrievedEvent

fn device_state(&self) -> DeviceState

Get the device state data field

fn set_device_state(&mut self, device_state: DeviceState)

Set the device state data field

fn device_status(&self) -> DeviceStatus

Get the device status data field

fn set_device_status(&mut self, device_status: DeviceStatus)

fn exception_status(&self) -> ExceptionStatus

Get the exception status data field

fn set_exception_status(&mut self, exception_status: ExceptionStatus)

fn misc_device_state(&self) -> MiscDeviceState

Get the miscellaneous device status data field

fn set_misc_device_state(&mut self, misc_device_state: MiscDeviceState)

fn model_number(&self) -> ModelNumber

Get the model number data field

fn set_model_number(&mut self, model_number: ModelNumber)

Set the model number data field

fn code_revision(&self) -> CodeRevision

Get the code revision data field

fn set_code_revision(&mut self, code_revision: CodeRevision)

Set the code revision data field

fn idling(&self) -> Idling

Get the idling device state data field

fn set_idling(&mut self, idling: Idling)

Get the idling device state data field

fn accepting(&self) -> Accepting

Get the accepting device state data field

fn set_accepting(&mut self, accepting: Accepting)

Get the accepting device state data field

fn escrowed_state(&self) -> EscrowedState

Get the escrowed state device state data field

fn set_escrowed_state(&mut self, escrowed_state: EscrowedState)

Get the escrowed state device state data field

fn stacking(&self) -> Stacking

Get the stacking device state data field

fn set_stacking(&mut self, stacking: Stacking)

Get the stacking device state data field

fn stacked_event(&self) -> StackedEvent

Get the stacked event device state data field

fn set_stacked_event(&mut self, stacked_event: StackedEvent)

Get the stacked event device state data field

fn returning(&self) -> Returning

Get the returning device state data field

fn set_returning(&mut self, returning: Returning)

Get the returning device state data field

fn returned_event(&self) -> ReturnedEvent

Get the returned event device state data field

fn set_returned_event(&mut self, returned_event: ReturnedEvent)

Get the returned event device state data field

fn cheated(&self) -> Cheated

Get the cheated device status data field

fn set_cheated(&mut self, cheated: Cheated)

Set the cheated device status data field

fn rejected(&self) -> Rejected

Get the rejected device status data field

fn set_rejected(&mut self, rejected: Rejected)

Set the rejected device status data field

fn jammed(&self) -> Jammed

Get the jammed device status data field

fn set_jammed(&mut self, jammed: Jammed)

Set the jammed device status data field

fn stacker_full(&self) -> StackerFull

Get the stacker full device status data field

fn set_stacker_full(&mut self, stacker_full: StackerFull)

Set the stacker full device status data field

fn cassette_attached(&self) -> CassetteAttached

Get the cassette attached device status data field

fn set_cassette_attached(&mut self, cassette_attached: CassetteAttached)

Set the cassette attached device status data field

fn cash_box_status(&self) -> CashBoxStatus

Get the status of the cash box

fn paused(&self) -> Paused

Get the paused device status data field

fn set_paused(&mut self, paused: Paused)

Set the paused device status data field

fn calibration(&self) -> Calibration

Get the calibration in progress device status data field

fn set_calibration(&mut self, calibration: Calibration)

Set the calibration in progress device status data field

fn power_up(&self) -> PowerUpStatus

Get the power up status data field

fn set_power_up(&mut self, power_up: PowerUpStatus)

Set the power up status data field

fn invalid_command(&self) -> InvalidCommand

Get the invalid command data field

fn set_invalid_command(&mut self, invalid_command: InvalidCommand)

Set the invalid command data field

fn failure(&self) -> Failure

Get the failure data field

fn set_failure(&mut self, failure: Failure)

Set the failure data field

fn note_value(&self) -> StandardDenomination

Get the note value data field

fn set_note_value(&mut self, note_value: StandardDenomination)

Set the note value data field

fn transport_open(&self) -> TransportOpen

Get the transport open data field

fn set_transport_open(&mut self, transport_open: TransportOpen)

Set the transport open data field

fn stalled(&self) -> Stalled

Get the stalled data field

fn set_stalled(&mut self, stalled: Stalled)

Set the stalled data field

fn flash_download(&self) -> FlashDownload

Get the flash download data field

fn set_flash_download(&mut self, flash_download: FlashDownload)

Set the flash download data field

fn pre_stack(&self) -> PreStack

Get the pre-stack data field

fn set_pre_stack(&mut self, pre_stack: PreStack)

Set the pre-stack data field

fn raw_barcode(&self) -> RawBarcode

Get the raw barcode data field

fn set_raw_barcode(&mut self, raw_barcode: RawBarcode)

Set the raw barcode data field

fn device_capabilities(&self) -> DeviceCapabilities

Get the device capabilities data field

fn set_device_capabilities(&mut self, device_capabilities: DeviceCapabilities)

Set the device capabilities data field

fn disabled(&self) -> Disabled

Get the disabled data field

fn set_disabled(&mut self, disabled: Disabled)

Set the disabled data field

impl PartialEq for NoteRetrievedEvent

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

impl StructuralPartialEq for NoteRetrievedEvent