usbsid-pico 0.1.9

Rust driver for USBSID-Pico – interface MOS SID chips (6581/8580) and hardware emulators over USB
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53

// usbsid-pico – Rust driver for the USBSID-Pico USB SID interface.
//
// Licensed under MIT OR Apache-2.0

//! Error types for the USBSID-Pico driver.

use thiserror::Error;

/// All errors that can occur when interacting with a USBSID-Pico device.
#[derive(Debug, Error)]
pub enum UsbSidError {
    /// The driver has not been initialised yet.
    #[error("USBSID driver not initialised")]
    NotInitialised,

    /// The USB port is not open / device not connected.
    #[error("USBSID port is not open")]
    PortNotOpen,

    /// No USBSID-Pico device was found on the bus.
    #[error("USBSID-Pico device not found (VID=0x{vid:04X} PID=0x{pid:04X})")]
    DeviceNotFound {
        /// USB Vendor ID that was searched for.
        vid: u16,
        /// USB Product ID that was searched for.
        pid: u16,
    },

    /// A `rusb` (libusb) operation failed.
    #[cfg(feature = "usb")]
    #[error("USB error: {0}")]
    Usb(#[from] rusb::Error),

    /// Thread-related error (e.g. failed to spawn).
    #[error("Thread error: {0}")]
    Thread(String),

    /// Attempted to use a direct-write function while the background thread is active.
    #[error("Operation not supported while threaded mode is active")]
    ThreadedModeActive,

    /// Attempted to use a ring-buffer function while not in the correct threaded mode.
    #[error("Ring write requires threaded={expected_threaded}, withcycles={expected_cycled}")]
    WrongThreadMode {
        /// Whether threaded mode was expected.
        expected_threaded: bool,
        /// Whether cycle-accurate mode was expected.
        expected_cycled: bool,
    },
}

/// Convenience alias used throughout the crate.
pub type Result<T> = std::result::Result<T, UsbSidError>;