Struct StepState 

pub struct StepState {

    pub current_step: usize,
    pub total_steps: usize,
    pub applied_changes: Vec<usize>,
    pub active_change: Option<usize>,
    pub cursor_change: Option<usize>,
    pub animating_hunk: Option<usize>,
    pub step_direction: StepDirection,
    pub current_hunk: usize,
    pub total_hunks: usize,
    pub last_nav_was_hunk: bool,
    pub hunk_preview_mode: bool,
    pub preview_from_backward: bool,
    pub show_hunk_extent_while_stepping: bool,
    /* private fields */
}

The current state of stepping through a diff

Fields

current_step: usize

Current step index (0 = initial state, 1 = after first change applied, etc.)

total_steps: usize

Total number of steps (number of significant changes + 1 for initial state)

applied_changes: Vec<usize>

IDs of changes that have been applied up to current step

active_change: Option<usize>

ID of the change being highlighted/animated at current step

cursor_change: Option<usize>

Cursor change used for non-stepping navigation (does not imply animation)

animating_hunk: Option<usize>

Hunk currently being animated (distinct from cursor position in current_hunk)

step_direction: StepDirection

Direction of the last step action

current_hunk: usize

Current hunk index (0-based)

total_hunks: usize

Total number of hunks

last_nav_was_hunk: bool

True if the last navigation was a hunk navigation (for extent marker display)

hunk_preview_mode: bool

True after hunkdown (full preview mode), cleared on first step

preview_from_backward: bool

True if preview was entered via hunkup (backward navigation)

show_hunk_extent_while_stepping: bool

Show hunk extent markers while stepping (set by UI)

Implementations

impl StepState

pub fn new(total_changes: usize, total_hunks: usize) -> Self

pub fn is_at_start(&self) -> bool

Check if we’re at the initial state (no changes applied)

pub fn is_at_end(&self) -> bool

Check if we’re at the final state (all changes applied)

pub fn progress(&self) -> f64

Get progress as a percentage

pub fn is_applied(&self, change_id: usize) -> bool

Trait Implementations

impl Clone for StepState

fn clone(&self) -> StepState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StepState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StepState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for StepState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.