Skip to main content

Nav

Struct Nav 

Source
pub struct Nav<R> { /* private fields */ }
Expand description

A navigation stack the app holds in its Model. The core owns the stack (single source of truth); the framework reads its route/depth to drive the shell’s push/pop transitions and back button.

R is your screen-route type (typically a small enum). Hold it in the model, mutate it in update (push/pop/reset), match current() in view, and build the shell with nav_scaffold. Wire a Msg::Back (or similar) event to pop so the back affordance works.

#[derive(Clone, Serialize)] enum Route { List, Detail(u32) }
// model.nav: Nav<Route> = Nav::new(Route::List);
// update: Msg::Open(id) => model.nav.push(Route::Detail(id)),
//         Msg::Back      => model.nav.pop(),
// view:   nav_scaffold(title, dark, tabs, body, &model.nav, Msg::Back)

Implementations§

Source§

impl<R: Clone + Serialize> Nav<R>

Source

pub fn new(root: R) -> Self

A stack containing a single root route.

Source

pub fn push(&mut self, route: R)

Push a new screen onto the stack.

Source

pub fn pop(&mut self)

Pop the top screen (no-op at the root).

Source

pub fn reset(&mut self, root: R)

Replace the whole stack with a fresh root (e.g. switching bottom-nav tabs).

Source

pub fn current(&self) -> &R

The current (top) route — what view should render.

Source

pub fn depth(&self) -> u32

Stack depth (root = 1).

Source

pub fn can_go_back(&self) -> bool

Whether there is a screen to pop back to.

Trait Implementations§

Source§

impl<R: Clone> Clone for Nav<R>

Source§

fn clone(&self) -> Nav<R>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<R: Debug> Debug for Nav<R>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> Freeze for Nav<R>

§

impl<R> RefUnwindSafe for Nav<R>
where R: RefUnwindSafe,

§

impl<R> Send for Nav<R>
where R: Send,

§

impl<R> Sync for Nav<R>
where R: Sync,

§

impl<R> Unpin for Nav<R>
where R: Unpin,

§

impl<R> UnsafeUnpin for Nav<R>

§

impl<R> UnwindSafe for Nav<R>
where R: UnwindSafe,

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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.