Skip to main content

StepperController

Struct StepperController 

Source
pub struct StepperController { /* private fields */ }
Expand description

Shared handle controlling a Stepper.

Implementations§

Source§

impl StepperController

Source

pub fn new(step_count: usize) -> Self

A controller for a stepper with step_count steps, starting at step 0.

Source

pub fn next(&self)

Advance to the next reachable step, recording the current one on the back-stack. Invisible (Step::visible_when) and StepStatus::Disabled steps are stepped over; a no-op when none remains.

Source

pub fn skip(&self)

Mark the current (optional) step skipped, then advance like next.

Source

pub fn back(&self)

Return to the most recently visited reachable step (the back-stack top). Entries that became unreachable meanwhile are popped and skipped. No-op on an empty stack.

Source

pub fn go_to(&self, idx: usize)

Jump to step idx (non-linear), recording the current step on the back-stack so back returns here. A no-op when idx is out of range or not reachable.

Source

pub fn reset(&self)

Reset to the first reachable step: clears the back-stack, restores the statuses the stepper was declared with (so a Disabled / Optional step keeps its character), and clears visited/skipped flags. Per-step visibility is app-owned and left untouched.

Source

pub fn set_status(&self, idx: usize, status: StepStatus)

Override a step’s StepStatus (e.g. mark it Error after async validation). Setting StepStatus::Disabled takes the step out of the flow — next / go_to skip it — but does not move off it if it is the active step.

Source

pub fn set_visible(&self, idx: usize, visible: bool)

Show or hide step idx. A hidden step is skipped by next / back / go_to and drops out of the indicator strip — the branching-wizard shape (“this step only if you chose X”) without maintaining two step lists.

Usually driven declaratively by Step::visible_when; this is the imperative twin. Hiding the active step does not navigate away from it — hide steps the user has not reached yet.

Source

pub fn current(&self) -> usize

Source

pub fn status(&self, idx: usize) -> StepStatus

Source

pub fn visited(&self, idx: usize) -> bool

true if step idx has ever been the active step.

Source

pub fn skipped(&self, idx: usize) -> bool

true if step idx was skipped via skip.

Source

pub fn is_visible(&self, idx: usize) -> bool

true if step idx is visible (see set_visible).

Source

pub fn is_reachable(&self, idx: usize) -> bool

true if step idx participates in the flow — visible and not StepStatus::Disabled.

Source

pub fn next_reachable(&self, from: usize) -> Option<usize>

The next reachable step after from, if any.

Source

pub fn has_next(&self) -> bool

true if next would move — i.e. the active step is not the last reachable one. The footer shows Next when this holds and Finish when it does not.

Source

pub fn step_count(&self) -> usize

Source

pub fn can_back(&self) -> bool

true if there is a previously-visited, still-reachable step to return to.

Source

pub fn current_step_signal(&self) -> Signal<usize>

The active-step signal — the stepper’s Switcher and indicators bind to it.

Source

pub fn version_signal(&self) -> Signal<u64>

Bumped on every structural mutation; bind at BindingLevel::Rebuild.

Trait Implementations§

Source§

impl Clone for StepperController

Source§

fn clone(&self) -> StepperController

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 Debug for StepperController

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> Downcast<T> for T

§

fn downcast(&self) -> &T

§

impl<T> ErasedDestructor for T
where T: 'static,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> Upcast<T> for T

§

fn upcast(&self) -> Option<&T>

§

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