oxide_core 0.4.0

Rust engine primitives for Oxide (store, snapshot streams, error model, optional persistence).
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

use crate::engine::navigation_runtime::NavigationRuntime;
use crate::engine::CoreResult;
use crate::navigation::{OxideRoute, OxideRouteKind, RouteContext};

/// Navigation capability surface injected into reducer/effect contexts.
///
/// Why: reducers/effects should not depend on Flutter types, but they often need to issue
/// navigation intents (push/pop) and inspect the current route.
pub struct NavigationCtx<'a> {
    runtime: &'a NavigationRuntime,
    route: &'a RouteContext,
}

impl<'a> NavigationCtx<'a> {
    /// Creates a navigation context snapshot for the current invocation.
    pub fn new(runtime: &'a NavigationRuntime, route: &'a RouteContext) -> Self {
        Self { runtime, route }
    }

    /// Returns the current route context snapshot.
    pub fn route(&self) -> &RouteContext {
        self.route
    }

    /// Pushes a route without expecting a result.
    pub fn push<R: OxideRoute>(&self, route: R) -> CoreResult<()> {
        self.runtime.push(route)
    }

    /// Pops the current route without a result.
    pub fn pop(&self) -> CoreResult<()> {
        self.runtime.pop()
    }

    /// Pops routes until the given kind becomes active.
    pub fn pop_until<K: OxideRouteKind>(&self, kind: K) -> CoreResult<()> {
        self.runtime.pop_until(kind)
    }
}