This is unreleased documentation for Yew Next version.
For up-to-date documentation, see the latest version on docs.rs.
yew_agent::worker

Struct WorkerScope

pub struct WorkerScope<W>
where W: Worker,
{ /* private fields */ }
Expand description

This struct holds a reference to a component and to a global scheduler.

Implementations§

§

impl<W> WorkerScope<W>
where W: Worker + 'static,

pub fn respond(&self, id: HandlerId, output: <W as Worker>::Output)

Send response to a worker bridge.

pub fn send_message<T>(&self, msg: T)
where T: Into<<W as Worker>::Message>,

Send a message to the worker

pub fn callback<F, IN, M>(&self, function: F) -> Rc<dyn Fn(IN)>
where M: Into<<W as Worker>::Message>, F: Fn(IN) -> M + 'static,

Create a callback which will send a message to the worker when invoked.

pub fn callback_future<FN, FU, IN, M>(&self, function: FN) -> Rc<dyn Fn(IN)>
where M: Into<<W as Worker>::Message>, FU: Future<Output = M> + 'static, FN: Fn(IN) -> FU + 'static,

This method creates a callback which returns a Future which returns a message to be sent back to the worker

§Panics

If the future panics, then the promise will not resolve, and will leak.

pub fn send_future<F, M>(&self, future: F)
where M: Into<<W as Worker>::Message>, F: Future<Output = M> + 'static,

This method processes a Future that returns a message and sends it back to the worker.

§Panics

If the future panics, then the promise will not resolve, and will leak.

Trait Implementations§

§

impl<W> Clone for WorkerScope<W>
where W: Worker,

§

fn clone(&self) -> WorkerScope<W>

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
§

impl<W> Debug for WorkerScope<W>
where W: Worker,

§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<W> Freeze for WorkerScope<W>

§

impl<W> !RefUnwindSafe for WorkerScope<W>

§

impl<W> !Send for WorkerScope<W>

§

impl<W> !Sync for WorkerScope<W>

§

impl<W> Unpin for WorkerScope<W>

§

impl<W> !UnwindSafe for WorkerScope<W>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. 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> IntoPropValue<Option<T>> for T

Source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
Source§

impl<T> IntoPropValue<T> for T

Source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

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

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

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

impl<Token, Builder, How> AllPropsFor<Builder, How> for Token
where Builder: Buildable<Token>, <Builder as Buildable<Token>>::WrappedToken: HasAllProps<<Builder as Buildable<Token>>::Output, How>,

Source§

impl<T> HasAllProps<(), T> for T