Skip to main content

TuiConfig

Struct TuiConfig 

Source
pub struct TuiConfig {
    pub confirm_countdown_secs: u32,
    pub auto_refresh_secs: u64,
    pub open: TuiOpenConfig,
    pub sidebar_position: SidebarPosition,
    pub keys: TuiKeysConfig,
    pub macro1: Option<TuiMacroConfig>,
    pub macro2: Option<TuiMacroConfig>,
}
Expand description

[tui] table — runtime knobs for the worktree TUI. Currently exposes the safety countdown on the delete-confirm overlay (issue #30): when delete_branch_on_remove has been toggled ON, the modal forces the user to wait N seconds (visualised by a progress bar) before the destructive action actually fires. 0 disables the countdown and falls back to the classic single-keystroke confirm even when delete- branch is armed; the value is clamped to 5 at read time so a typo like confirm_countdown_secs = 300 can never strand a destructive path behind a 300-second wait.

Fields§

§confirm_countdown_secs: u32

Safety countdown (in seconds) applied to the confirm overlay when delete_branch_on_remove is ON. Accepts any non-negative integer; values above Self::MAX_CONFIRM_COUNTDOWN_SECS are clamped on read via Self::effective_confirm_countdown_secs. The field is u32 (rather than u8) so a typo like confirm_countdown_secs = 300 still round-trips through TOML deserialization and reaches the clamp instead of erroring out at parse time.

§auto_refresh_secs: u64

Periodic worktree-list refresh interval in seconds. Default 60 keeps Issue/PR table state reasonably fresh; 0 disables the automatic refresh loop.

§open: TuiOpenConfig

[tui.open] sub-table — drives the dispatch of the o key in the list view. Default mode is shell (lazygit-like worktree-manager workflow); pre-#73 behaviour (open / xdg-open / explorer) is kept available under mode = "finder".

§sidebar_position: SidebarPosition

Which side the worktree-details sidebar sits on in the side-by-side layout (issue #188). Default right preserves pre-#188 behaviour; left flips the split. Toggled live in the TUI with H. Ignored by the stacked (narrow-terminal) layout, where the sidebar is always at the bottom.

§keys: TuiKeysConfig

[tui.keys] sub-table (issue #87) — user overrides for the remappable keymap. Absent → keymap stays at the built-in defaults. Present → every listed action replaces its default binding set; actions left unmentioned keep their defaults. An empty array (down = []) unbinds the action entirely.

§macro1: Option<TuiMacroConfig>

[tui.macro1] — user-defined command bound to h by default (#290). Absent → the key does nothing.

§macro2: Option<TuiMacroConfig>

[tui.macro2] — user-defined command bound to H by default (#290). Absent → the key does nothing.

Implementations§

Source§

impl TuiConfig

Source

pub const MAX_CONFIRM_COUNTDOWN_SECS: u32 = 5

Documented range cap. Centralised so the TUI and the doctor share the same clamp logic.

Source

pub fn effective_confirm_countdown_secs(&self) -> u32

Effective countdown value used by the TUI, clamped to [0, MAX_CONFIRM_COUNTDOWN_SECS]. The raw field stays at the user’s value so a future doctor check can surface “your config asked for X but we capped at 5”.

Trait Implementations§

Source§

impl Clone for TuiConfig

Source§

fn clone(&self) -> TuiConfig

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 TuiConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for TuiConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for TuiConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for TuiConfig

Source§

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

Serialize this value into the given Serde serializer. 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
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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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

Source§

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

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

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

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

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
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> 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
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.