Get a suggestion for how to resolve this error. Returns a human-readable suggestion that can help users understand what action to take to resolve the error. # Returns An optional string with a suggestion, or `None` if no specific suggestion is available. # Example ```rust,ignore let err = CliError::repository_not_found("/home/user/project"); if let Some(suggestion) = err.suggestion() { eprint
(&self)
| 506 | /// } |
| 507 | /// ``` |
| 508 | pub fn suggestion(&self) -> Option<&'static str> { |
| 509 | match self { |
| 510 | Self::RepositoryNotFound { .. } => { |
| 511 | Some("Run 'atomic init' to create a new repository, or change to a directory inside an existing repository.") |
| 512 | } |
| 513 | Self::RepositoryExists { .. } => { |
| 514 | Some("The directory is already an Atomic repository. Use 'atomic status' to see its state.") |
| 515 | } |
| 516 | Self::ViewNotFound { .. } => { |
| 517 | Some("Run 'atomic view list' to see available views, or 'atomic view create <name>' to create a new one.") |
| 518 | } |
| 519 | Self::ViewAlreadyExists { .. } => { |
| 520 | Some("Choose a different name, or use 'atomic view switch <name>' to switch to the existing view.") |
| 521 | } |
| 522 | Self::CannotDeleteCurrentView { .. } => { |
| 523 | Some("Switch to a different view first with 'atomic view switch <name>', then delete this one.") |
| 524 | } |
| 525 | Self::FileNotFound { .. } => { |
| 526 | Some("Check that the file path is correct. Use 'ls' or your file manager to verify the file exists.") |
| 527 | } |
| 528 | Self::FileNotTracked { .. } => { |
| 529 | Some("Run 'atomic add <file>' to start tracking this file.") |
| 530 | } |
| 531 | Self::FileAlreadyTracked { .. } => { |
| 532 | Some("This file is already tracked. Use 'atomic status' to see its current state.") |
| 533 | } |
| 534 | Self::PathOutsideRepository { .. } => { |
| 535 | Some("Atomic can only track files within the repository. Move the file inside the repository or initialize a new repository in its parent directory.") |
| 536 | } |
| 537 | Self::NothingToRecord => { |
| 538 | Some("Make some changes to tracked files, or use 'atomic add' to track new files.") |
| 539 | } |
| 540 | Self::ChangeNotFound { .. } => { |
| 541 | Some("Run 'atomic log' to see available changes and their hashes.") |
| 542 | } |
| 543 | Self::AmbiguousHash { .. } => { |
| 544 | Some("Provide more characters of the hash to uniquely identify the change.") |
| 545 | } |
| 546 | Self::MissingDependency { .. } => { |
| 547 | Some("Insert the required dependency first, or use '--force' to skip dependency checking (not recommended).") |
| 548 | } |
| 549 | Self::RemoteNotFound { .. } => { |
| 550 | Some("Check your repository configuration, or add a remote with 'atomic remote add <name> <url>'.") |
| 551 | } |
| 552 | Self::AuthenticationFailed { .. } => { |
| 553 | Some("Check your credentials. You may need to set up SSH keys or update your access token.") |
| 554 | } |
| 555 | Self::GitError { .. } => { |
| 556 | Some("A Git operation failed. Ensure you are in a valid Git repository, the referenced branch or commit exists, and you have the necessary permissions. Run 'git status' and 'git branch' to investigate.") |
| 557 | } |
| 558 | Self::IdentityNotFound(_) => { |
| 559 | Some("Run 'atomic identity list' to see available identities, or 'atomic identity new <name>' to create one.") |
| 560 | } |
| 561 | Self::IdentityAlreadyExists(_) => { |
| 562 | Some("Choose a different name, or use 'atomic identity show <name>' to view the existing identity.") |
| 563 | } |
| 564 | Self::Cancelled => None, |
| 565 | Self::InvalidArgument { .. } => { |
no outgoing calls