Enum openrazer::devices::Device

pub enum Device {
    Huntsman(Huntsman),
    Other(GenericDevice),
}

A Razer device, possibly a specific one.

This enum represents some Razer device. It has methods for each capability (e.g. brightness, effects and keyboard layout), but these methods check that the capability is present, because they operate on an unkonwn device. If it is, then a special struct, which controls the capatibily, is returned.

This crate also has types for specific devices, e.g. Razer Hunstman. If the underlying device is known to this crate, it will construct a variant for this speicifc device, e.g. Device::Huntsman instead of Device::Other for yet unknown devices. You can match on this enum and use a type-safer API that knows the device's capabilities, e.g. trying to set DPI for a keyboard will result in a compile-time error.

Variants

Huntsman(Huntsman)

A Razer Huntsman keyboard.

Other(GenericDevice)

A device unknown to this crate.

Implementations

impl Device

pub fn breath_effect(&self) -> Option<BreathEffect>

Controls the breath effect.

pub fn custom_effect(&self) -> Option<CustomEffect>

Controls the custom effect.

pub fn brightness(&self) -> Option<Brightness>

Controls the device's brightness.

pub fn game_mode(&self) -> Option<GameMode>

Controls the device's Game Mode.

pub fn keyboard_layout(&self) -> Option<KeyboardLayout>

Gets the device's keyboard layout.

pub fn macro_effect(&self) -> Option<MacroEffect>

Controls the device's macro effect.

pub fn macro_mode(&self) -> Option<MacroMode>

Controls the device's Macro Mode.

pub fn matrix_dimensions(&self) -> Option<MatrixDimensions>

Gets the device's matrix dimensions.

pub fn no_effect(&self) -> Option<NoEffect>

Disables any lighting effect.

pub fn reactive_effect(&self) -> Option<ReactiveEffect>

Controls the reactive effect.

pub fn ripple_effect(&self) -> Option<RippleEffect>

Controls the ripple effect.

pub fn spectrum_effect(&self) -> Option<SpectrumEffect>

Sets the spectrum effect.

pub fn starlight_effect(&self) -> Option<StarlightEffect>

Sets the starlight effect.

pub fn static_effect(&self) -> Option<StaticEffect>

Controls the static effect.

pub fn wave_effect(&self) -> Option<WaveEffect>

Controls the wave effect.

Trait Implementations

impl Clone for Device

fn clone(&self) -> Device

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Device

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

Formats the value using the given formatter.

impl GenericMethods for Device

fn get_generic_device(&self) -> &GenericDevice

Gets the underlying GenericDevice.

fn serial(&self) -> &str

Gets the device's serial.

fn capabilities(&self) -> AvailableCapabilities

Gets available capabilities.

fn name(&self) -> BoxFuture<'_, Result<String, Error>>

Gets the device's name.

fn firmware_version(&self) -> BoxFuture<'_, Result<String, Error>>

Gets the device's firmware version.

fn driver_version(&self) -> BoxFuture<'_, Result<String, Error>>

Gets the driver version for the device.

fn has_dedicated_macro_keys(&self) -> BoxFuture<'_, Result<bool, Error>>

Checks if the device has dedicated macro keys.

fn razer_urls(&self) -> BoxFuture<'_, Result<HashMap<String, String>, Error>>

Gets Razer URLs.