Skip to main content

PublishStateMachine

Struct PublishStateMachine 

Source
pub struct PublishStateMachine {
    state: PublishState,
}
Expand description

Pure state machine for a MoQT publish request (publisher side). Transitions: Idle → Publishing → Active → Done.

Fields§

§state: PublishState

Implementations§

Source§

impl PublishStateMachine

Source

pub fn on_publish_received(&mut self) -> Result<(), PublishFlowError>

Idle -> Publishing (PUBLISH received from the peer).

Source

pub fn on_publish_ok_sent(&mut self) -> Result<(), PublishFlowError>

Publishing -> Active (PUBLISH_OK sent to the offering peer).

Source

pub fn on_publish_error_sent(&mut self) -> Result<(), PublishFlowError>

Publishing -> Done (PUBLISH_ERROR sent to the offering peer).

Source

pub fn on_publish_done_received(&mut self) -> Result<(), PublishFlowError>

Active -> Done (PUBLISH_DONE received from the offering peer).

Source

pub fn on_unsubscribe_sent(&mut self) -> Result<(), PublishFlowError>

Active -> Done (UNSUBSCRIBE sent to the offering peer).

The same transition as the one above and a separate name, because a refusal has to say which of the two events was refused.

Source

pub fn on_unsubscribe_received(&mut self) -> Result<(), PublishFlowError>

Active -> Done (UNSUBSCRIBE received from the subscribing peer).

The mirror of the one above, on an offer this endpoint made rather than one it took. Both directions are held in this one map, so the event name is the only thing that says which of them was refused.

Source§

impl PublishStateMachine

Source

pub fn new() -> Self

Creates a new state machine in the PublishState::Idle state.

Source

pub fn state(&self) -> PublishState

Returns the current state of the publish request.

Source

pub fn on_publish_sent(&mut self) -> Result<(), PublishError>

Idle → Publishing (PUBLISH sent).

Source

pub fn on_publish_ok(&mut self) -> Result<(), PublishError>

Publishing → Active (PUBLISH_OK received).

Source

pub fn on_publish_error(&mut self) -> Result<(), PublishError>

Publishing → Done (PUBLISH_ERROR received).

Source

pub fn on_publish_done_sent(&mut self) -> Result<(), PublishError>

Active → Done (PUBLISH_DONE sent by publisher).

Trait Implementations§

Source§

impl Default for PublishStateMachine

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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.

§

impl<T> Instrument for T

§

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

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

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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