Struct relm::Component[−][src]

pub struct Component<WIDGET: Widget> { /* fields omitted */ }

Expand description

Widget that was added by the ContainerWidget::add_widget() method.

Warning

You must keep your components as long as you want them to send/receive events. Common practice is to store Components in the Widget struct (see the communication example). The #[widget] attribute takes care of storing them in the struct automatically (see the communication-attribute example).

Implementations

impl<WIDGET: Widget> Component<WIDGET>

pub fn emit(&self, msg: WIDGET::Msg)

Emit a message of the widget stream.

pub fn stream(&self) -> StreamHandle<WIDGET::Msg>

Get the event stream of the component. This is used internally by the library.

pub fn owned_stream(&self) -> &EventStream<WIDGET::Msg>

Get the event stream of the component. This is used internally by the library.

pub fn widget(&self) -> &WIDGET::Root

Get the widget of the component.

Auto Trait Implementations

impl<WIDGET> RefUnwindSafe for Component<WIDGET> where
    <WIDGET as Update>::Msg: RefUnwindSafe,
    <WIDGET as Widget>::Root: RefUnwindSafe,

impl<WIDGET> !Send for Component<WIDGET>

impl<WIDGET> !Sync for Component<WIDGET>

impl<WIDGET> Unpin for Component<WIDGET> where
    <WIDGET as Widget>::Root: Unpin,

impl<WIDGET> UnwindSafe for Component<WIDGET> where
    <WIDGET as Update>::Msg: RefUnwindSafe,
    <WIDGET as Widget>::Root: UnwindSafe,

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

pub fn from(t: T) -> T

Performs the conversion.

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

pub fn into(self) -> U

Performs the conversion.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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

Performs the conversion.