Struct pcsc::Transaction

pub struct Transaction<'tx> { /* fields omitted */ }

An exclusive transaction with a card.

A transaction ensures uninterrupted access to the card for its duration. All other operations performed on the same underlying card (even from other processes) will block until the transaction is finished.

Methods

impl<'tx> Transaction<'tx>

pub fn end(
    self,
    disposition: Disposition
) -> Result<(), (Transaction<'tx>, Error)>

End the transaction.

In case of error, ownership of the transaction is returned to the caller.

This function wraps SCardEndTransaction (pcsclite, MSDN).

Note

Transaction implements Drop which automatically ends the transaction using Disposition::LeaveCard; you only need to call this function if you want to handle errors or use a different disposition method.

Methods from Deref<Target = Card>

pub fn status(&self) -> Result<(Status, Protocol), Error>

Deprecated since 2.3.0:

Not portable; use status2() instead.

Get current info on the card.

This function wraps SCardStatus (pcsclite, MSDN).

Deprecated

The Status return value is not portable to Windows.

The reader names and ATR return values are missing.

Use status2() instead.

pub fn status2<'names_buf, 'atr_buf>(
    &self,
    names_buffer: &'names_buf mut [u8],
    atr_buffer: &'atr_buf mut [u8]
) -> Result<CardStatus<'names_buf, 'atr_buf>, Error>

Get current info on the card.

names_buffer is a buffer that should be large enough to hold all of the reader names.

atr_buffer is a buffer that should be large enough to hold the ATR. The recommended size is MAX_ATR_SIZE, which should be always sufficent.

The function status2_len can be used to find the exact required lengths.

If the buffers are not large enough to hold all of the names or the ATR, Error::InsufficientBuffer is returned.

This function wraps SCardStatus (pcsclite, MSDN).

pub fn status2_len(&self) -> Result<(usize, usize), Error>

Get the needed length of the names buffer (first result) and ATR buffer (second result) to be passed to status2.

This function wraps SCardStatus (pcsclite, MSDN).

pub fn get_attribute<'buf>(
    &self,
    attribute: Attribute,
    buffer: &'buf mut [u8]
) -> Result<&'buf [u8], Error>

Get an attribute of the card or card reader.

buffer is a buffer that should be large enough for the attribute data. The function get_attribute_len can be used to find the exact required length.

Returns a slice into buffer containing the attribute data.

If the buffer is not large enough, Error::InsufficientBuffer is returned.

This function wraps SCardGetAttrib (pcsclite, MSDN).

pub fn get_attribute_len(&self, attribute: Attribute) -> Result<usize, Error>

Get the needed length of a buffer to be passed to get_attribute.

This function wraps SCardGetAttrib (pcsclite, MSDN).

pub fn set_attribute(
    &self,
    attribute: Attribute,
    attribute_data: &[u8]
) -> Result<(), Error>

Set an attribute of the card or card reader.

This function wraps SCardSetAttrib (pcsclite, MSDN).

pub fn transmit<'buf>(
    &self,
    send_buffer: &[u8],
    receive_buffer: &'buf mut [u8]
) -> Result<&'buf [u8], Error>

Transmit an APDU command to the card.

receive_buffer is a buffer that should be large enough to hold the APDU response.

Returns a slice into receive_buffer containing the APDU response.

If receive_buffer is not large enough to hold the APDU response, Error::InsufficientBuffer is returned.

This function wraps SCardTransmit (pcsclite, MSDN).

pub fn control<'buf>(
    &self,
    control_code: DWORD,
    send_buffer: &[u8],
    receive_buffer: &'buf mut [u8]
) -> Result<&'buf [u8], Error>

Sends a command directly to the reader (driver).

control_code is the reader-specific control code. You may need to pass it through the ctl_code() function, according to the driver documentation.

receive_buffer is a buffer that should be large enough to hold the response.

Returns a slice into receive_buffer containing the response.

If receive_buffer is not large enough to hold the response, Error::InsufficientBuffer is returned.

This function wraps SCardControl (pcsclite, MSDN).

Trait Implementations

impl<'tx> Deref for Transaction<'tx>

type Target = Card

The resulting type after dereferencing.

fn deref(&self) -> &Card

Dereferences the value.

impl<'tx> Drop for Transaction<'tx>

fn drop(&mut self)

Executes the destructor for this type.