Enum ApiError

pub enum ApiError {
    StartLoginServer,
    NotLoggedIn,
    DeleteCredentialsFile(Error),
    DeleteProjectMetadataFile(Error),
    ReadCredentialsFile(Error),
    ReadProjectMetadataFile(Error),
    ReadUserDotGrafbaseFolder(Error),
    ReadProjectDotGrafbaseFolder(Error),
    UnlinkedProject,
    CorruptCredentialsFile,
    CorruptAccessToken,
    CorruptProjectMetadataFile,
    UnauthorizedOrDeletedUser,
    IncorrectlyScopedToken,
    ReadSchema,
    WriteProjectMetadataFile(Error),
    RequestError,
    ConnectionError,
    ProjectAlreadyLinked,
    FindUserDotGrafbaseFolder,
    CreateUserDotGrafbaseFolder(Error),
    CreateProjectDotGrafbaseFolder(Error),
    FindAvailablePort,
    UploadError,
    ReadArchiveMetadata(Error),
    ReadArchive(Error),
    AppendToArchive(Error),
    CreateTempFile(Error),
    CreateError(CreateError),
    DeployError(DeployError),
}

Variants

StartLoginServer

returned if the login server could not be started

NotLoggedIn

returned if the user is not logged in when attempting to use a command requiring auth

DeleteCredentialsFile(Error)

returned if ~/.grafbase/credentials.json could not be deleted

DeleteProjectMetadataFile(Error)

returned if ~/.grafbase/project.json could not be deleted

ReadCredentialsFile(Error)

returned if ~/.grafbase/credentials.json could not be read

ReadProjectMetadataFile(Error)

returned if .grafbase/project.json could not be read

ReadUserDotGrafbaseFolder(Error)

returned if ~/.grafbase could not be read

ReadProjectDotGrafbaseFolder(Error)

returned if .grafbase could not be read

UnlinkedProject

returned if an operation failed due to the project not being linked

CorruptCredentialsFile

returned if the contents of the credential file are corrupt

CorruptAccessToken

returned if the provided access token is corrupt

CorruptProjectMetadataFile

returned if the contents of the project metadata file are corrupt

UnauthorizedOrDeletedUser

returned if an operation failed due to a token being unauthorized or the user previously being deleted

IncorrectlyScopedToken

returned if a token does not have access to a user’s personal account

ReadSchema

returned if a project schema could not be read

WriteProjectMetadataFile(Error)

returned if the project metadata file could not be written

RequestError

returned if a cynic request could not be completed

ConnectionError

returned if a cynic request could not be completed (due to connection issues)

ProjectAlreadyLinked

returned if a project being created has already been created

FindUserDotGrafbaseFolder

returned if the path of ~/.grafbase could not be found

CreateUserDotGrafbaseFolder(Error)

returned if ~/.grafbase could not be created

CreateProjectDotGrafbaseFolder(Error)

returned if .grafbase could not be created

FindAvailablePort

returned if an available port could not be find

UploadError

returned if a the request to upload the archive fails

ReadArchiveMetadata(Error)

returned if the upload archive metadata could not be read

ReadArchive(Error)

returned if the upload archive could not be read

AppendToArchive(Error)

returned if a file or directory could not be appended to the upload archive

CreateTempFile(Error)

returned if a temporary file for the upload archive could not be created

CreateError(CreateError)

wraps a CreateError

DeployError(DeployError)

wraps a DeployError

Trait Implementations

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

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<CreateError> for ApiError

fn from(source: CreateError) -> Self

Converts to this type from the input type.

impl From<CynicReqwestError> for ApiError

fn from(error: CynicReqwestError) -> Self

Converts to this type from the input type.

impl From<DeployError> for ApiError

fn from(source: DeployError) -> Self

Converts to this type from the input type.