Struct medea_jason::peer::TransitableStateController

pub struct TransitableStateController<S, T> { /* fields omitted */ }

Component managing all kinds of TransitableState.

Implementations

impl<S, T> TransitableStateController<S, T> where
    S: InStable<Transition = T> + Into<TransitableState<S, T>> + 'static,
    T: InTransition<Stable = S> + Into<TransitableState<S, T>> + 'static, 

#[must_use]pub fn new(state: S) -> Rc<Self>

Returns new TransitableStateController with the provided stable state.

pub fn subscribe_stable(&self) -> LocalBoxStream<'static, S>

Returns Stream into which the TransitableState::Stable updates will be emitted.

pub fn subscribe_transition(&self) -> LocalBoxStream<'static, T>

Returns Stream into which the TransitableState::Transition updates will be emitted.

pub fn stop_transition_timeout(&self)

Stops disable/enable timeout of this TransitableStateController.

pub fn reset_transition_timeout(&self)

Resets disable/enable timeout of this TransitableStateController.

#[must_use]pub fn state(&self) -> TransitableState<S, T>

Returns current TransitableStateController::state.

pub fn transition_to(&self, desired_state: S)

Starts transition of the TransitableStateController::state to the provided one.

pub fn when_media_state_stable(
    &self,
    desired_state: S
) -> LocalBoxFuture<'static, Result<(), Traced<MediaConnectionsError>>>

Returns Future which will be resolved when state of this TransitableStateController will be TransitableState::Stable or the TransitableStateController is dropped.

Succeeds if TransitableStateController’s state transits into the desired_state or the TransitableStateController is dropped.

Errors

MediaConnectionsError::MediaStateTransitsIntoOppositeState is returned if TransitableStateController’s MediaState transits into the opposite to the desired_state.

pub fn when_processed(&self) -> Processed<'static>

Returns Processed that will be resolved once all the underlying data updates are processed by all subscribers.

pub fn when_stabilized(self: Rc<Self>) -> Processed<'static, ()>

Returns Future which will be resolved once TransitableState is transited to the TransitableState::Stable.

impl TransitableStateController<Stable, Transition>

#[must_use]pub fn muted(&self) -> bool

Indicates whether TransitableStateController’s mute state is in mute_state::Stable::Muted.

#[must_use]pub fn unmuted(&self) -> bool

Indicates whether TransitableStateController’s mute state is in mute_state::Stable::Unmuted.

impl TransitableStateController<Stable, Transition>

#[must_use]pub fn disabled(&self) -> bool

Indicates whether TransitableStateController’s media exchange state is in media_exchange_state::Stable::Disabled.

#[must_use]pub fn enabled(&self) -> bool

Indicates whether TransitableStateController’s media exchange state is in media_exchange_state::Stable::Enabled.

Trait Implementations

impl<S: Debug, T: Debug> Debug for TransitableStateController<S, T>

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

Formats the value using the given formatter.