Crate yew_agent

source ·
Expand description

This module contains Yew’s web worker implementation.

Types

There’re a couple kinds of agents:

Oneshot

A kind of agent that for each input, a single output is returned.

Reactor

A kind of agent that can send many inputs and receive many outputs over a single bridge.

Worker

The low-level implementation of agents that provides an actor model and communicates with multiple bridges.

Reachability

When an agent is spawned, each agent is associated with a reachability.

Private

Each time a bridge is created, a new instance of agent is spawned. This allows parallel computing between agents.

Public

Public agents are shared among all children of a provider. Only 1 instance will be spawned for each public agents provider.

Provider

Each Agent requires a provider to provide communications and maintain bridges. All hooks must be called within a provider.

Communications with Agents

Hooks provides means to communicate with agent instances.

Bridge

See: use_worker_bridge, use_reactor_bridge

A bridge takes a callback to receive outputs from agents and provides a handle to send inputs to agents.

Subscription

See: use_worker_subscription, use_reactor_subscription

Similar to bridges, a subscription produces a handle to send inputs to agents. However, instead of notifying the receiver with a callback, it collect all outputs into a slice.

Runner

See: use_oneshot_runner

Unlike other agents, oneshot bridges provide a use_oneshot_runner hook to execute oneshot agents on demand.

Modules

  • oneshot
    This module provides task agent implementation.
  • prelude
    Prelude module to be imported when working with yew-agent.
  • reactor
    This module contains the reactor agent implementation.
  • scope_ext
    This module contains extensions to the component scope for agent access.
  • worker
    This module contains the worker agent implementation.

Structs

Enums

  • Reach
    The reachability of an agent.

Traits

  • Codec
    Message Encoding and Decoding Format
  • Registrable
    A trait to enable public workers being registered in a web worker.
  • Spawnable
    A Worker that can be spawned by a spawner.