Method suggestion

atomic-core/src/change/format_v3/error.rs:282–301

Returns a human-readable suggestion for how to fix this error. This is intended for CLI error reporting where a "did you mean?" style hint can guide the user.

(&self)

    /// This is intended for CLI error reporting where a "did you mean?"
    /// style hint can guide the user.
    pub fn suggestion(&self) -> Option<&'static str> {
        match self {
            FormatError::InvalidMagic { .. } => {
                Some("This file may be a V1/V2 change file. Re-record with the current version.")
            }
            FormatError::UnsupportedVersion { .. } => {
                Some("Update Atomic to a version that supports this format.")
            }
            FormatError::HashTableFull => {
                Some("Split this change into smaller changes with fewer dependencies.")
            }
            FormatError::HashMismatch { .. } => {
                Some("The change file may be corrupt. Try re-downloading or re-recording.")
            }
            FormatError::SectionTruncated { .. } | FormatError::UnexpectedEof { .. } => {
                Some("The file appears truncated. Try re-downloading.")
            }
            _ => None,
        }
    }
}

#[cfg(test)]