Enum GitHubDocsError

pub enum GitHubDocsError {
    InvalidRepoFormat {
        input: String,
    },
    RepositoryNotFound {
        owner: String,
        repo: String,
    },
    NoDocumentationFound {
        owner: String,
        repo: String,
    },
    DownloadFailed {
        path: String,
        reason: String,
    },
    GitOperationFailed {
        command: String,
        stderr: String,
    },
    InvalidUrl {
        url: String,
    },
    FileSystemError(Error),
    UrlParseError(ParseError),
    PathError(StripPrefixError),
    WalkDirError(Error),
    RepoOwnerValidationError(RepoOwnerError),
    RepoNameValidationError(RepoNameError),
}

Comprehensive error type for GitHub documentation operations.

This error type provides specific variants for different failure modes, making it easier to handle errors appropriately and provide useful feedback to users.

Variants

InvalidRepoFormat

Invalid repository format provided

Fields

input: String

The invalid input that was provided

RepositoryNotFound

Repository not found or access denied

Fields

owner: String

Repository owner name

repo: String

Repository name

NoDocumentationFound

No documentation directories found

Fields

owner: String

Repository owner name

repo: String

Repository name

DownloadFailed

File download failed

Fields

path: String

Path of the file that failed to download

reason: String

Reason for the download failure

GitOperationFailed

Git operation failed

Fields

command: String

Git command that failed

stderr: String

Standard error output from the git command

InvalidUrl

Invalid URL provided

Fields

url: String

The invalid URL that was provided

FileSystemError(Error)

File system operation failed

UrlParseError(ParseError)

URL parsing failed

PathError(StripPrefixError)

Path manipulation failed

WalkDirError(Error)

WalkDir error

RepoOwnerValidationError(RepoOwnerError)

Repository owner validation error

RepoNameValidationError(RepoNameError)

Repository name validation error

Implementations

impl GitHubDocsError

pub fn repository_not_found( owner: impl Into<String>, repo: impl Into<String>, ) -> Self

Create a repository not found error.

pub fn no_documentation_found( owner: impl Into<String>, repo: impl Into<String>, ) -> Self

Create a no documentation found error.

pub fn download_failed( path: impl Into<String>, reason: impl Into<String>, ) -> Self

Create a download failed error.

pub fn git_operation_failed( command: impl Into<String>, stderr: impl Into<String>, ) -> Self

Create a git operation failed error.

Trait Implementations

impl Debug for GitHubDocsError

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

Formats the value using the given formatter.

impl Display for GitHubDocsError

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

Formats the value using the given formatter.

impl Error for GitHubDocsError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for GitHubDocsError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<Error> for GitHubDocsError

fn from(source: Error) -> Self

Converts to this type from the input type.

impl From<ParseError> for GitHubDocsError

fn from(source: ParseError) -> Self

Converts to this type from the input type.

impl From<RepoNameError> for GitHubDocsError

fn from(source: RepoNameError) -> Self

Converts to this type from the input type.

impl From<RepoOwnerError> for GitHubDocsError

fn from(source: RepoOwnerError) -> Self

Converts to this type from the input type.

impl From<StripPrefixError> for GitHubDocsError

fn from(source: StripPrefixError) -> Self

Converts to this type from the input type.