Struct aaronia_rtsa::ApiHandle

pub struct ApiHandle { /* private fields */ }

Handle to interface the library

Internally, all ApiHandles use one global library handle, which is dropped when there are no ApiHandles left. Only the first handle, i.e., the one that creates the global library handle can configure the Memory size. Later created ApiHandles ignore the memory parameter.

Implementations

impl ApiHandle

pub fn new() -> Result<Self, Error>

Create ApiHandle with default Memory size medium.

pub fn with_mem(mem: Memory) -> Result<Self, Error>

Create ApiHandle with given Memory size.

The memory size is only considered, if this is the first ApiHandle, i.e. the one that initializes the underlying RTSA library.

pub fn rescan_devices(&mut self) -> Result

Rescan for devices.

pub fn reset_devices(&mut self) -> Result

Reset all devices.

pub fn devices(&mut self) -> Result<Vec<DeviceInfo>, Error>

Get a list with information about all detected devices.

pub fn get_device(&mut self) -> Result<Device, Error>

Get the first detected Device.

pub fn get_this_device(&mut self, info: &DeviceInfo) -> Result<Device, Error>

Get a specific Device, identified by its DeviceInfo.

The DeviceInfo can be get from the devices() function.

Trait Implementations

impl Debug for ApiHandle

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

Formats the value using the given formatter.

impl Drop for ApiHandle

fn drop(&mut self)

Executes the destructor for this type.