Skip to main content

WorktreeConfig

Struct WorktreeConfig 

Source
pub struct WorktreeConfig {
    pub mode: WorktreeMode,
    pub base_dir: PathBuf,
    pub prefix: String,
    pub auto_gitignore: bool,
    pub default_editor: String,
    pub cleanup: WorktreeCleanupConfig,
    pub merge_detection: WorktreeMergeDetectionConfig,
    pub status: WorktreeStatusConfig,
}
Expand description

Configuration for worktree management

Fields§

§mode: WorktreeMode

Worktree storage mode (local or global)

§base_dir: PathBuf

Base directory for worktrees

  • Local mode: relative to repo root (e.g., “.worktrees”)
  • Global mode: absolute path or relative to workspace root
§prefix: String

Default branch prefix for managed worktrees

§auto_gitignore: bool

Automatically manage .gitignore for worktree directories

§default_editor: String

Default editor command for opening worktrees

§cleanup: WorktreeCleanupConfig

Cleanup configuration

§merge_detection: WorktreeMergeDetectionConfig

Merge detection configuration

§status: WorktreeStatusConfig

Status display configuration

Implementations§

Source§

impl WorktreeConfig

Source

pub fn get_resolved_base_dir(&self, repo_root: Option<&Path>) -> PathBuf

Get the resolved base directory based on mode and configuration

Source

pub fn from_env() -> Self

Load configuration from environment variables, falling back to defaults

Source

pub fn load_with_overrides() -> Result<Self, String>

Load configuration with environment variable overrides and validation

Source

pub fn validate(&self) -> Result<(), String>

Enhanced validation with more comprehensive checks

Source

pub fn get_help_text() -> &'static str

Get configuration documentation for help system

Source

pub fn sample_config_yaml() -> String

Create a sample configuration for documentation

Trait Implementations§

Source§

impl Clone for WorktreeConfig

Source§

fn clone(&self) -> WorktreeConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for WorktreeConfig

Source§

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

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

impl Default for WorktreeConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for WorktreeConfig

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 WorktreeConfig

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

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

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

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