CommandGroup

Struct CommandGroup 

Source
pub struct CommandGroup<'a> { /* private fields */ }
Expand description

Command equivalent for a ControllerGroup, which allow you to update multiple controllers.

This is useful when doing updates for multiple controllers at once.

Implementations§

Source§

impl<'a> CommandGroup<'a>

Source

pub async fn execute(self) -> OpenRgbResult<()>

Executes all commands in this group one after another.

Source

pub fn set_controller_led<C: Into<Color>>( &mut self, controller_id: impl ControllerIndex, led_id: usize, color: C, ) -> OpenRgbResult<()>

Add a command to update a single LED in a controller.

§Errors

Returns an error if the controller is not found in this group.

Source

pub fn set_controller_leds<C: Into<Color>>( &mut self, controller_id: impl ControllerIndex, colors: impl IntoIterator<Item = C>, ) -> OpenRgbResult<()>

Add a command to update a multiple LEDs in a controller

§Errors

Returns an error if the controller is not found in this group.

Source

pub fn set_controller_zone_leds<C: Into<Color>>( &mut self, controller_id: impl ControllerIndex, zone_id: usize, colors: impl IntoIterator<Item = C>, ) -> OpenRgbResult<()>

Add a command to update a zone in a controller.

§Errors

Returns an error if the controller is not found in this group.

Source

pub fn set_controller_zone_led<C: Into<Color>>( &mut self, controller_id: impl ControllerIndex, zone_id: usize, led_idx: usize, color: C, ) -> OpenRgbResult<()>

Add a command to update a single LED in a zone in a controller.

§Errors

Returns an error if the controller is not found in this group.

Source

pub fn set_controller_segment_leds<C: Into<Color>>( &mut self, controller_id: impl ControllerIndex, zone_id: usize, segment_id: usize, colors: impl IntoIterator<Item = C>, ) -> OpenRgbResult<()>

Add a command to update a segment in a zone in a controller.

§Errors

Returns an error if the controller is not found in this group.

Auto Trait Implementations§

§

impl<'a> Freeze for CommandGroup<'a>

§

impl<'a> !RefUnwindSafe for CommandGroup<'a>

§

impl<'a> Send for CommandGroup<'a>

§

impl<'a> Sync for CommandGroup<'a>

§

impl<'a> Unpin for CommandGroup<'a>

§

impl<'a> !UnwindSafe for CommandGroup<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more