Enum SystemEffect 

pub enum SystemEffect {
    Alert {
        title: String,
        message: String,
    },
    HttpGet {
        url: String,
        headers: HashMap<String, String>,
    },
    FileRead {
        path: String,
    },
    Cancel {
        req_id: u64,
    },
    ReleaseResource {
        resource_id: u64,
    },
    OpenUrl {
        url: String,
        in_app: bool,
    },
    Authenticate {
        url: String,
        callback_scheme: String,
    },
}

Built-in system effects that every platform executor must handle.

These cover the most common async operations an application needs. For app-specific effects, use Effect::App with an opaque byte payload.

Example

fn fetch_data(state: &mut MyState, _action: FetchTodos, ctx: &mut ReducerContext<MyState>) {
    ctx.effects.http_get("https://api.example.com/todos")
        .on_ok(ctx.effects.bind(TodosLoaded, handle_loaded as fn(&mut MyState, TodosLoaded)));
}

Variants

Alert

Show a native alert dialog with a title and message.

Fields

title: String

message: String

HttpGet

Perform an HTTP GET request.

Fields

url: String

headers: HashMap<String, String>

FileRead

Read a file from the local filesystem.

Fields

path: String

Cancel

Cancel a previously issued effect by its request id.

Fields

req_id: u64

ReleaseResource

Release a platform-managed resource.

Fields

resource_id: u64

OpenUrl

Open a URL in the system browser or an in-app browser sheet.

When in_app is true, the URL opens in a Custom Tab / SFSafariViewController overlay. When false, the URL opens in the external browser app.

Fields

url: String

in_app: bool

Authenticate

Initiate an OAuth / secure authentication session.

The platform opens the url and listens for a redirect matching callback_scheme. The redirect URL is delivered as the effect result.

Fields

url: String

callback_scheme: String

Trait Implementations

impl Clone for SystemEffect

fn clone(&self) -> SystemEffect

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SystemEffect

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SystemEffect

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SystemEffect

fn eq(&self, other: &SystemEffect) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SystemEffect

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SystemEffect

impl StructuralPartialEq for SystemEffect