Struct Root

Source

pub struct Root<T>where
    T: Component,
{ /* private fields */ }

Available on crate feature winio only.

Expand description

Helper to run a root component.

Implementations§

Source §

impl<T> Root<T>
where T: Component,

Source

pub async fn init<'a>( init: impl Into<<T as Component>::Init<'a>>, ) -> Result<Root<T>, <T as Component>::Error>

Create a new root component.

Source

pub fn post(&mut self, message: <T as Component>::Message)

Post message to the component.

Source

pub async fn emit( &mut self, message: <T as Component>::Message, ) -> Result<bool, <T as Component>::Error>

Emit message to the component.

Source

pub fn sender(&self) -> &ComponentSender<T>

Get the sender of the component.

Source

pub fn into_child(self) -> Child<T>

Convert the root component into a child component.

Source

pub fn run( &mut self, ) -> impl Stream<Item = RunEvent<<T as Component>::Event, <T as Component>::Error>> + use<'_, T>

Run the component, and yield its events.

Source §

impl<T> Root<T>
where T: Component + 'static,

Source

pub fn into_boxed( self, ) -> Root<BoxComponent<<T as Component>::Message, <T as Component>::Event, <T as Component>::Error>>

Box the component.

Auto Trait Implementations§

§

impl<T> Freeze for Root<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Root<T>
where T: RefUnwindSafe,

§

impl<T> Send for Root<T>
where T: Send, <T as Component>::Message: Send, <T as Component>::Event: Send,

§

impl<T> Sync for Root<T>
where T: Sync, <T as Component>::Message: Send, <T as Component>::Event: Send,

§

impl<T> Unpin for Root<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Root<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Root<T>
where T: UnwindSafe,

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.

Source §

impl<T> Instrument for T

Source §

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

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

Source §

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 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> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §