pub struct Effects<MSG, XMSG> {
pub local: Vec<Cmd<MSG>>,
pub external: Vec<Cmd<XMSG>>,
}
Expand description
Effects is a convenient way to group Msg for component to execute subsequent updates based on certain conditions. This can be used for doing animation and incremental changes to the view to provide an effect of transition or animation.
Effects contains 2 types of Messages. The local messages which will be executed in its own component on the next update loop. The other type is the external effects which are Messages that are sent to the parent Component in response to an event that has been triggerred.
Fields§
§local: Vec<Cmd<MSG>>
Messages that will be executed locally in the Component
external: Vec<Cmd<XMSG>>
effects that will be executed on the parent Component which instantiate this component
Implementations§
source§impl<MSG, XMSG> Effects<MSG, XMSG>where
MSG: 'static,
impl<MSG, XMSG> Effects<MSG, XMSG>where
MSG: 'static,
sourcepub fn new(
local: impl IntoIterator<Item = MSG>,
external: impl IntoIterator<Item = XMSG>
) -> Effects<MSG, XMSG>where
XMSG: 'static,
pub fn new(
local: impl IntoIterator<Item = MSG>,
external: impl IntoIterator<Item = XMSG>
) -> Effects<MSG, XMSG>where
XMSG: 'static,
create a new Effects with local and external expects respectively
sourcepub fn with_local(local: impl IntoIterator<Item = MSG>) -> Effects<MSG, XMSG>
pub fn with_local(local: impl IntoIterator<Item = MSG>) -> Effects<MSG, XMSG>
Create an Effects with local messages that will be executed on the next update loop on this Component
sourcepub fn with_external(
external: impl IntoIterator<Item = XMSG>
) -> Effects<MSG, XMSG>where
XMSG: 'static,
pub fn with_external(
external: impl IntoIterator<Item = XMSG>
) -> Effects<MSG, XMSG>where
XMSG: 'static,
Create an Effects with extern messages that will be executed on the parent Component
sourcepub fn map_msg<F, MSG2>(self, f: F) -> Effects<MSG2, XMSG>
pub fn map_msg<F, MSG2>(self, f: F) -> Effects<MSG2, XMSG>
Map the local messages of this Effects such that MSG will be transposed into
MSG2 with the use of the mapping function f
.
The external messages stays the same.
sourcepub fn map_external<F, XMSG2>(self, f: F) -> Effects<MSG, XMSG2>
pub fn map_external<F, XMSG2>(self, f: F) -> Effects<MSG, XMSG2>
Map the external messages of this Effects such that XMSG will be transposed into XMSG2
with the use of the mapping function f
sourcepub fn localize<F, XMSG2>(self, f: F) -> Effects<XMSG, XMSG2>
pub fn localize<F, XMSG2>(self, f: F) -> Effects<XMSG, XMSG2>
derives an Effects which contains only local effects by transforming the external messages
and mapping them with function f
such that they can be of the same type as local effects
them merge them together into local effects.
sourcepub fn append_local(
self,
local: impl IntoIterator<Item = MSG>
) -> Effects<MSG, XMSG>
pub fn append_local( self, local: impl IntoIterator<Item = MSG> ) -> Effects<MSG, XMSG>
Append this msgs to the local effects
sourcepub fn batch(
all_effects: impl IntoIterator<Item = Effects<MSG, XMSG>>
) -> Effects<MSG, XMSG>
pub fn batch( all_effects: impl IntoIterator<Item = Effects<MSG, XMSG>> ) -> Effects<MSG, XMSG>
Merge all the internal objects of this Vec of Effects to produce only one.
sourcepub fn extend(
self,
local: impl IntoIterator<Item = MSG>,
external: impl IntoIterator<Item = XMSG>
) -> Effects<MSG, XMSG>where
XMSG: 'static,
pub fn extend(
self,
local: impl IntoIterator<Item = MSG>,
external: impl IntoIterator<Item = XMSG>
) -> Effects<MSG, XMSG>where
XMSG: 'static,
Extern the local and external MSG of this Effect