Struct streamduck_core::core::CoreHandle

pub struct CoreHandle { /* private fields */ }

Handle that’s given out to a module to perform actions on the core

Implementations

impl CoreHandle

pub fn wrap(core: Arc<SDCore>) -> CoreHandle

Wraps core reference with a handle, used for all core features to be able to bypass feature checking

pub fn check_for_feature(&self, feature: &str) -> bool

Checks if module is allowed to use this feature

pub fn required_feature(&self, feature: &str)

Warns if module is using feature it hasn’t reported

pub fn clone_for(&self, module: &UniqueSDModule) -> CoreHandle

Clones the handle for specified module

pub fn core(&self) -> Arc<SDCore>

Returns core reference

pub fn config(&self) -> Arc<Config>

Returns config reference

pub fn module_manager(&self) -> Arc<ModuleManager>

Returns module manager reference

pub fn socket_manager(&self) -> Arc<SocketManager>

Returns socket manager reference

pub fn current_stack(&self) -> LockResult<MutexGuard<'_, Vec<ButtonPanel>>>

Returns current stack lock

pub fn send_core_event_to_modules<T: Iterator<Item = UniqueSDModule> + Send + 'static>(
    &self,
    event: SDCoreEvent,
    modules: T
)

Sends core event to all modules, spawns a separate thread to do it, so doesn’t block current thread

pub fn get_stack(&self) -> Vec<ButtonPanel>

Gets current panel stack

pub fn get_current_screen(&self) -> Option<ButtonPanel>

Gets panel that’s currently on top of the stack

pub fn get_button(&self, key: u8) -> Option<UniqueButton>

Returns a button from current screen on specified position

pub fn set_button(&self, key: u8, button: UniqueButton) -> bool

Sets button to current screen with specified position

pub fn clear_button(&self, key: u8) -> bool

Clears button from current screen on specified position

pub fn add_component(&self, key: u8, component_name: &str) -> bool

Adds component onto a button, returns success boolean

pub fn get_component_values(
    &self,
    key: u8,
    component_name: &str
) -> Option<Vec<UIValue>>

Gets component values from a component on a button

pub fn get_component_values_with_paths(
    &self,
    key: u8,
    component_name: &str
) -> Option<Vec<UIPathValue>>

Gets component values from component on a button, but with paths for easier interaction with values

pub fn set_component_value(
    &self,
    key: u8,
    component_name: &str,
    value: Vec<UIValue>
) -> bool

Sets component values based on changes for component on a button

pub fn add_element_component_value(
    &self,
    key: u8,
    component_name: &str,
    path: &str
) -> bool

Adds new array element to a component value

pub fn remove_element_component_value(
    &self,
    key: u8,
    component_name: &str,
    path: &str,
    index: usize
) -> bool

Removes element from array in component value

pub fn set_component_value_by_path(
    &self,
    key: u8,
    component_name: &str,
    value: UIPathValue
) -> bool

Sets value based on path for component value

pub fn remove_component(&self, key: u8, component_name: &str) -> bool

Removes component from a button

pub fn paste_button(&self, key: u8, reference_button: &Button) -> bool

Creates a new button taking provided one as an example and makes all responsible modules handle the paste action

pub fn push_screen(&self, screen: ButtonPanel)

Pushes new panel into the stack

pub fn pop_screen(&self)

Pops panel from stack

pub fn get_root_screen(&self) -> ButtonPanel

Returns first panel of the stack for saving purposes

pub fn save_panels_to_value(&self) -> Value

Returns first panel of the stack that’s already been serialized

pub fn reset_stack(&self, panel: ButtonPanel)

Clears the stack and loads provided panel into the stack

pub fn load_panels_from_value(&self, panels: Value) -> Result<(), JSONError>

Clears the stack, attempts to deserialize provided panel value into an actual panel and then pushes it into the stack

pub fn button_down(&self, key: u8)

Triggers button down event on all modules

pub fn button_up(&self, key: u8)

Triggers button up event on all modules

pub fn button_action(&self, key: u8)

Triggers button action event for modules that are related to components of the button

pub fn get_button_images(&self) -> Option<HashMap<u8, DynamicImage>>

Renders what current screen would look like into DynamicImage map

pub fn get_button_image(&self, key: u8) -> Option<DynamicImage>

Renders what specified button would look like into DynamicImage

pub fn replace_screen(&self, screen: ButtonPanel)

Replaces current screen with specified one

pub fn set_brightness(&self, brightness: u8)

Sets brightness of the streamdeck to specified (Range from 0 to 100)

pub fn commit_changes(&self)

Commits all changes to layout to device config so it can be later saved

Trait Implementations

impl Clone for CoreHandle

fn clone(&self) -> CoreHandle

Returns a copy of the value.

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

Performs copy-assignment from source.