Struct Device 

pub struct Device {
    pub model: Model,
    pub proto: TouchProto,
    pub dims: (u32, u32),
    pub dpi: u16,
    metadata: OnceCell<DeviceMetadata>,
    wifi_manager: OnceCell<Box<dyn WifiManager>>,
}

Fields

model: Model

proto: TouchProto

dims: (u32, u32)

dpi: u16

metadata: OnceCell<DeviceMetadata>

wifi_manager: OnceCell<Box<dyn WifiManager>>

Implementations

impl Device

fn new(product: &str, model_number: &str) -> Device

Creates a new device from product and model number strings.

pub fn metadata(&self) -> Result<&DeviceMetadata, DeviceError>

Gets device metadata (lazy initialization).

pub fn usb_manager(&self) -> Result<Box<dyn UsbManager>, UsbError>

Creates USB manager for this device.

pub fn wifi_manager(&self) -> Result<&dyn WifiManager, WifiError>

Returns the WiFi manager for this device.

pub fn install_subdir(&self) -> &'static str

Returns the install subdirectory for this build.

Kobo devices install Cadmus under .adds/ on the user-visible storage. Test builds use a separate sibling directory so they can coexist with stable builds.

pub fn install_dir(&self) -> PathBuf

Returns the absolute install directory for this device.

The path is determined at compile time and does not depend on the process’s current working directory, so it remains stable even when callers change cwd.

• Normal device builds: /mnt/onboard/.adds/cadmus
• Test device builds: /mnt/onboard/.adds/cadmus-tst
• Emulator builds: /tmp/.adds/cadmus (or cadmus-tst with test)
• Unit tests: <temp_dir>/test-kobo-installation/.adds/cadmus-tst

pub fn install_path(&self, relative_path: impl AsRef<Path>) -> PathBuf

Returns a path inside the device install directory.

Use this for files and directories that Cadmus owns under its install root, such as tmp/ or .github_token.

pub fn tmp_dir(&self) -> PathBuf

Returns the path to the device-managed tmp directory.

The returned path is rooted under Device::install_dir, so it remains stable even when callers change cwd (for example during USB sharing).

pub fn clean_tmp_dir(&self)

Removes stale contents left by a previous run and recreates the tmp directory.

Device owns the lifecycle of the tmp directory: callers may assume the directory exists after this runs and should not create it themselves. Call this once at startup before any feature that writes to tmp_dir() to ensure a clean slate.

pub fn color_samples(&self) -> usize

Returns the number of color samples for the device screen.

pub fn frontlight_kind(&self) -> FrontlightKind

Returns the frontlight kind for this device.

pub fn has_natural_light(&self) -> bool

Returns true if the device has natural light capability.

pub fn has_lightsensor(&self) -> bool

Returns true if the device has a light sensor.

pub fn has_gyroscope(&self) -> bool

Returns true if the device has a gyroscope.

pub fn has_page_turn_buttons(&self) -> bool

Returns true if the device has page turn buttons.

pub fn has_power_cover(&self) -> bool

Returns true if the device supports a power cover.

pub fn has_removable_storage(&self) -> bool

Returns true if the device has removable storage.

pub fn should_invert_buttons(&self, rotation: i8) -> bool

Returns true if buttons should be inverted for the given rotation.

pub fn orientation(&self, rotation: i8) -> Orientation

Returns the orientation for the given rotation.

pub fn mark(&self) -> u8

Returns the device mark value.

pub fn should_mirror_axes(&self, rotation: i8) -> (bool, bool)

Returns whether axes should be mirrored for the given rotation.

pub fn mirroring_scheme(&self) -> (i8, i8)

Returns the center and direction of the mirroring pattern.

pub fn should_swap_axes(&self, rotation: i8) -> bool

Returns true if axes should be swapped for the given rotation.

fn swapping_scheme(&self) -> i8

Returns the swapping scheme value.

pub fn startup_rotation(&self) -> i8

Returns the startup rotation value.

pub fn to_canonical(&self, n: i8) -> i8

Returns a device independent rotation value.

pub fn from_canonical(&self, n: i8) -> i8

Returns a device dependent rotation value from canonical.

pub fn transformed_rotation(&self, n: i8) -> i8

Returns the transformed rotation value.

pub fn transformed_gyroscope_rotation(&self, n: i8) -> i8

Returns the transformed gyroscope rotation value.

Trait Implementations

impl Debug for Device

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

Formats the value using the given formatter.