Struct IndexWarning 

pub struct IndexWarning {
    pub reason: String,
    pub action_required: String,
    pub files_modified: Option<Vec<String>>,
    pub files_added: Option<Vec<String>>,
    pub files_deleted: Option<Vec<String>>,
    pub changed_count: Option<usize>,
    pub truncated: bool,
    pub details: Option<IndexWarningDetails>,
}

Warning details when index is stale

Fields

reason: String

Human-readable reason why index is stale

action_required: String

Command to run to fix the issue

files_modified: Option<Vec<String>>

Tracked files edited since the index was built.

BREAKING in 1.7.2: this was a u32 count. It is now the paths themselves, because a count told an agent something was wrong without telling it what, so the only safe reaction was to distrust the whole result. The list is capped; truncated says when.

files_added: Option<Vec<String>>

Files present on disk but absent from the index (new or untracked).

files_deleted: Option<Vec<String>>

Files in the index but no longer on disk. These produce ghost hits.

changed_count: Option<usize>

Total changed paths, which may exceed the lengths of the lists above.

truncated: bool

Whether the lists were cut short. Set on a fresh checkout or a huge rebase.

details: Option<IndexWarningDetails>

Additional context (git branch info, etc.)

Implementations

impl IndexWarning

pub fn new( reason: impl Into<String>, action_required: impl Into<String>, ) -> Self

A warning with only a reason and an action, no file lists.

pub fn with_details(self, details: IndexWarningDetails) -> Self

Attach git branch/commit context.

Trait Implementations

impl Clone for IndexWarning

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IndexWarning

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for IndexWarning

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for IndexWarning

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

where __S: Serializer,

Serialize this value into the given Serde serializer.