Struct streamduck_core::modules::core_module::CoreModule

source · [−]

pub struct CoreModule { /* private fields */ }

Expand description

The core module, for exposing renderer component to requests and such

Trait Implementations

source

impl SDModule for CoreModule

source

fn name(&self) -> String

Module name

source

fn components(&self) -> HashMap<String, ComponentDefinition>

Definition for components that module will be providing

source

fn add_component(&self, _: CoreHandle, button: &mut Button, name: &str)

Method for adding components onto buttons

source

fn remove_component(&self, _: CoreHandle, button: &mut Button, name: &str)

Method for removing components from buttons

source

fn paste_component(
    &self,
    _: CoreHandle,
    reference_button: &Button,
    new_button: &mut Button
)

Method for handling pasting components of plugin, can be used for any additional handling

source

fn component_values(
 &self,
 core: CoreHandle,
 button: &Button,
 name: &str
) -> Vec<UIValue>

Method for letting core know what values component currently has

source

fn set_component_value(
 &self,
 core: CoreHandle,
 button: &mut Button,
 name: &str,
 value: Vec<UIValue>
)

Method for setting values on components

source

fn listening_for(&self) -> Vec<String>

Specifies which components the module will be receiving events for

source

fn settings(&self, core_manager: Arc<CoreManager>) -> Vec<UIValue>

Current settings state of the plugin

source

fn set_setting(&self, core_manager: Arc<CoreManager>, value: Vec<UIValue>)

Method for updating plugin settings from UI

source

fn event(&self, core: CoreHandle, event: SDCoreEvent)

Method for handling core events, add CORE_EVENTS feature to the plugin metadata to receive core events

source

fn metadata(&self) -> PluginMetadata

Metadata of the module, auto-implemented for plugins from plugin metadata

source

fn global_event(&self, event: SDGlobalEvent)

Method for handling global events, add GLOBAL_EVENTS feature to the plugin metadata to receive global events

source

fn render(&self, core: CoreHandle, button: &UniqueButton, frame: &mut DynamicImage)

Method renderer will run for rendering additional information on a button if RENDERING feature was specified

source

fn render_hash(
 &self,
 core: CoreHandle,
 button: &UniqueButton,
 hash: &mut Box<dyn Hasher>
)

Method for telling renderer if anything changed Read more

Auto Trait Implementations

impl RefUnwindSafe for CoreModule

impl Send for CoreModule

impl Sync for CoreModule

impl Unpin for CoreModule

impl UnwindSafe for CoreModule

Blanket Implementations

source

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
 T: FloatComponent,
 Swp: WhitePoint,
 Dwp: WhitePoint,
 D: AdaptFrom<S, Swp, Dwp, T>,

source

fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,

Convert the source color to the destination color using the specified method Read more

source

fn adapt_into(self) -> D

Convert the source color to the destination color using the bradford method by default Read more

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,

type Err = NoError

The error type produced by a failed conversion.

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

Convert the given value into an approximately equivalent representation.

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

The error type produced by a failed conversion.

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

Convert the subject into an approximately equivalent representation.

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject with the default scheme.

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

Approximate the subject with a specific scheme.

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

Approximate the subject to a given type with the default scheme.

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

Approximate the subject to a given type with a specific scheme.

fn into_as<Dst>(self) -> Dst where
Self: Into<Dst>,

Convert the subject to a given type.

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: TryInto<Dst>,

Attempt to convert the subject to a given type.

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ValueInto<Dst>,

Attempt a value conversion of the subject to a given type.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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> IntoColor for T where
U: FromColor<T>,

source

fn into_color(self) -> U

Convert into T with values clamped to the color defined bounds Read more

source

impl<T, U> IntoColorUnclamped for T where
U: FromColorUnclamped<T>,

source

fn into_color_unclamped(self) -> U

Convert into T. The resulting color might be invalid in its color space Read more

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<Src> TryFrom<Src> for Src

type Err = NoError

The error type produced by a failed conversion.

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

Convert the given value into the subject type.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

impl<Src, Dst> TryInto<Dst> for Src where
Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

The error type produced by a failed conversion.

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

Convert the subject into the destination type.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

impl<T, U> TryIntoColor for T where
U: TryFromColor<T>,

source

fn try_into_color(self) -> Result<U, OutOfBounds>

Convert into T, returning ok if the color is inside of its defined range, otherwise an OutOfBounds error is returned which contains the unclamped color. Read more

Struct streamduck_core::modules::core_module::CoreModule

Trait Implementations

impl SDModule for CoreModule

fn name(&self) -> String

fn components(&self) -> HashMap<String, ComponentDefinition>

fn add_component(&self, _: CoreHandle, button: &mut Button, name: &str)

fn remove_component(&self, _: CoreHandle, button: &mut Button, name: &str)

fn paste_component( &self, _: CoreHandle, reference_button: &Button, new_button: &mut Button)

fn component_values( &self, core: CoreHandle, button: &Button, name: &str) -> Vec<UIValue>

fn set_component_value( &self, core: CoreHandle, button: &mut Button, name: &str, value: Vec<UIValue>)

fn listening_for(&self) -> Vec<String>

fn settings(&self, core_manager: Arc<CoreManager>) -> Vec<UIValue>

fn set_setting(&self, core_manager: Arc<CoreManager>, value: Vec<UIValue>)

fn event(&self, core: CoreHandle, event: SDCoreEvent)

fn metadata(&self) -> PluginMetadata

fn global_event(&self, event: SDGlobalEvent)

fn render(&self, core: CoreHandle, button: &UniqueButton, frame: &mut DynamicImage)

fn render_hash( &self, core: CoreHandle, button: &UniqueButton, hash: &mut Box<dyn Hasher>)

Auto Trait Implementations

impl RefUnwindSafe for CoreModule

impl Send for CoreModule

impl Sync for CoreModule

impl Unpin for CoreModule

impl UnwindSafe for CoreModule

Blanket Implementations

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where T: FloatComponent, Swp: WhitePoint, Dwp: WhitePoint, D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D where M: TransformMatrix<Swp, Dwp, T>,

fn adapt_into(self) -> D

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

fn type_id(&self) -> TypeId

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where Scheme: ApproxScheme,

type Err = NoError

fn approx_from(src: Src) -> Result<Src, <Src as ApproxFrom<Src, Scheme>>::Err>

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where Dst: ApproxFrom<Src, Scheme>, Scheme: ApproxScheme,

type Err = <Dst as ApproxFrom<Src, Scheme>>::Err

fn approx_into(self) -> Result<Dst, <Src as ApproxInto<Dst, Scheme>>::Err>

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

fn borrow(&self) -> &T

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

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

impl<T, Dst> ConvAsUtil<Dst> for T

fn approx(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, DefaultApprox>,

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

impl<T> ConvUtil for T

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, DefaultApprox>,

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where Self: ApproxInto<Dst, Scheme>, Scheme: ApproxScheme,

fn into_as<Dst>(self) -> Dst where Self: Into<Dst>,

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where Self: TryInto<Dst>,

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where Self: ValueInto<Dst>,

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T, U> IntoColor<U> for T where U: FromColor<T>,

fn into_color(self) -> U

impl<T, U> IntoColorUnclamped<U> for T where U: FromColorUnclamped<T>,

fn into_color_unclamped(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<Src> TryFrom<Src> for Src

type Err = NoError

fn try_from(src: Src) -> Result<Src, <Src as TryFrom<Src>>::Err>

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

type Error = Infallible

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

impl<Src, Dst> TryInto<Dst> for Src where Dst: TryFrom<Src>,

type Err = <Dst as TryFrom<Src>>::Err

fn try_into(self) -> Result<Dst, <Src as TryInto<Dst>>::Err>

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

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

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

impl<T, U> TryIntoColor<U> for T where U: TryFromColor<T>,

fn try_into_color(self) -> Result<U, OutOfBounds<U>>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

fn paste_component(
&self,
_: CoreHandle,
reference_button: &Button,
new_button: &mut Button
)

fn component_values(
&self,
core: CoreHandle,
button: &Button,
name: &str
) -> Vec<UIValue>

fn set_component_value(
&self,
core: CoreHandle,
button: &mut Button,
name: &str,
value: Vec<UIValue>
)

fn render_hash(
&self,
core: CoreHandle,
button: &UniqueButton,
hash: &mut Box<dyn Hasher>
)

impl<S, D, Swp, Dwp, T> AdaptInto<D, Swp, Dwp, T> for S where
T: FloatComponent,
Swp: WhitePoint,
Dwp: WhitePoint,
D: AdaptFrom<S, Swp, Dwp, T>,

fn adapt_into_using<M>(self, method: M) -> D where
M: TransformMatrix<Swp, Dwp, T>,

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

impl<Src, Scheme> ApproxFrom<Src, Scheme> for Src where
Scheme: ApproxScheme,

impl<Dst, Src, Scheme> ApproxInto<Dst, Scheme> for Src where
Dst: ApproxFrom<Src, Scheme>,
Scheme: ApproxScheme,

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

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

fn approx(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

fn approx_by<Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

fn approx_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, DefaultApprox>,

fn approx_as_by<Dst, Scheme>(self) -> Result<Dst, Self::Err> where
Self: ApproxInto<Dst, Scheme>,
Scheme: ApproxScheme,

fn into_as<Dst>(self) -> Dst where
Self: Into<Dst>,

fn try_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: TryInto<Dst>,

fn value_as<Dst>(self) -> Result<Dst, Self::Err> where
Self: ValueInto<Dst>,

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

impl<T, U> IntoColor<U> for T where
U: FromColor<T>,

impl<T, U> IntoColorUnclamped<U> for T where
U: FromColorUnclamped<T>,

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

impl<Src, Dst> TryInto<Dst> for Src where
Dst: TryFrom<Src>,

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

impl<T, U> TryIntoColor<U> for T where
U: TryFromColor<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

impl<Src, Dst> ValueInto<Dst> for Src where
Dst: ValueFrom<Src>,