Enum Error 

#[non_exhaustive]
pub enum Error {
    Io(Error),
    UnavailableFileCommand {
        var: &'static str,
        operation: &'static str,
    },
    MissingEnvFile {
        var: &'static str,
        path: PathBuf,
    },
    DelimiterCollision,
    ReservedName(String),
    InvalidBool {
        name: String,
        value: String,
    },
    MissingRequiredInput(String),
    ParseInput {
        name: String,
        reason: String,
    },
    SummaryTooLarge {
        bytes: usize,
    },
    InvalidName {
        name: String,
        reason: &'static str,
    },
}

Errors produced by fallible actions-rs operations.

#[non_exhaustive] so new variants can be added without a breaking change.

Examples

use actions_rs::Error;

// Reserved names are rejected before any write happens.
let err = actions_rs::output::export_var("GITHUB_TOKEN", "x").unwrap_err();
assert!(matches!(err, Error::ReservedName(_)));
// `Display` is human-readable.
assert!(err.to_string().contains("reserved"));

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Io(Error)

An underlying I/O error while reading or appending an environment file.

UnavailableFileCommand

The runner did not provide the required environment-file path for an operation whose stdout command fallback has been retired.

Fields

var: &'static str

The environment variable that should point at the file.

operation: &'static str

The attempted operation (for diagnostics).

MissingEnvFile

The environment-file variable pointed at a path that does not exist.

GitHub sets these (GITHUB_ENV, GITHUB_OUTPUT, …) to a real file; if the variable is present but the file is missing the runner state is broken and we surface it rather than silently dropping the write.

Fields

var: &'static str

The environment variable name (e.g. GITHUB_OUTPUT).

path: PathBuf

The path the variable pointed at.

DelimiterCollision

The randomly generated heredoc delimiter collided with the key or value being written. Astronomically unlikely; retrying will pick a fresh delimiter. Mirrors @actions/core, which also errors in this case.

ReservedName(String)

Attempted to export a reserved variable via crate::output::export_var (GITHUB_*, RUNNER_*, or NODE_OPTIONS). The runner forbids this.

InvalidBool

A boolean input did not match the strict YAML 1.2 core schema (true|True|TRUE|false|False|FALSE).

Fields

name: String

The input name that was queried.

value: String

The offending raw value.

MissingRequiredInput(String)

A required input was absent or empty.

ParseInput

A typed input could not be parsed into the requested type.

Fields

name: String

The input name that was queried.

reason: String

A human-readable reason from the type’s FromStr implementation.

SummaryTooLarge

The job summary buffer exceeded GitHub’s 1 MiB per-step limit.

Fields

bytes: usize

The size of the buffer that was rejected, in bytes.

InvalidName

A key or path contained a carriage return or line feed, which would corrupt the line-oriented environment-file syntax (and could inject extra entries). Rejected before anything is written.

Fields

name: String

The offending value.

reason: &'static str

Why it was rejected.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error

fn from(e: Error) -> Self

Converts to this type from the input type.