Enum nu_protocol::ShellError

source ·

pub enum ShellError {
Show 94 variants    OperatorMismatch {
        op_span: Span,
        lhs_ty: Type,
        lhs_span: Span,
        rhs_ty: Type,
        rhs_span: Span,
    },
    OperatorOverflow(String, Span, String),
    PipelineMismatch(String, Span, Span),
    OnlySupportsThisInputType(String, String, Span, Span),
    PipelineEmpty(Span),
    TypeMismatch(String, Span),
    TypeMismatchGenericMessage {
        err_message: String,
        span: Span,
    },
    UnsupportedOperator(Operator, Span),
    AssignmentRequiresVar(Span),
    AssignmentRequiresMutableVar(Span),
    UnknownOperator(String, Span),
    MissingParameter(String, Span),
    IncompatibleParameters {
        left_message: String,
        left_span: Span,
        right_message: String,
        right_span: Span,
    },
    DelimiterError(String, Span),
    IncompatibleParametersSingle(String, Span),
    FeatureNotEnabled(Span),
    ExternalNotSupported(Span),
    InvalidProbability(Span),
    InvalidRange(String, String, Span),
    NushellFailed(String),
    NushellFailedSpanned(String, String, Span),
    NushellFailedHelp(String, String),
    NushellFailedSpannedHelp(String, String, Span, String),
    VariableNotFoundAtRuntime(Span),
    EnvVarNotFoundAtRuntime(String, Span),
    ModuleNotFoundAtRuntime(String, Span),
    ModuleOrOverlayNotFoundAtRuntime(String, Span),
    OverlayNotFoundAtRuntime(String, Span),
    NotFound(Span),
    CantConvert(String, String, Span, Option<String>),
    CantConvertWithValue(String, String, String, Span, Span, Option<String>),
    EnvVarNotAString(String, Span),
    AutomaticEnvVarSetManually(String, Span),
    CannotReplaceEnv(Span),
    DivisionByZero(Span),
    CannotCreateRange(Span),
    AccessBeyondEnd(usize, Span),
    InsertAfterNextFreeIndex(usize, Span),
    AccessEmptyContent(Span),
    AccessBeyondEndOfStream(Span),
    IncompatiblePathAccess(String, Span),
    CantFindColumn(String, Span, Span),
    ColumnAlreadyExists(String, Span, Span),
    NotAList(Span, Span),
    ExternalCommand(String, String, Span),
    UnsupportedInput(String, String, Span, Span),
    DatetimeParseError(Span),
    NetworkFailure(String, Span),
    CommandNotFound(Span),
    AliasNotFound(Span),
    FlagNotFound(String, Span),
    FileNotFound(Span),
    FileNotFoundCustom(String, Span),
    PluginFailedToLoad(String),
    PluginFailedToEncode(String),
    PluginFailedToDecode(String),
    IOInterrupted(String, Span),
    IOError(String),
    IOErrorSpanned(String, Span),
    PermissionDeniedError(String, Span),
    OutOfMemoryError(String, Span),
    NotADirectory(Span),
    DirectoryNotFound(Span, Option<String>),
    DirectoryNotFoundCustom(String, Span),
    MoveNotPossible {
        source_message: String,
        source_span: Span,
        destination_message: String,
        destination_span: Span,
    },
    MoveNotPossibleSingle(String, Span),
    CreateNotPossible(String, Span),
    ChangeAccessTimeNotPossible(String, Span),
    ChangeModifiedTimeNotPossible(String, Span),
    RemoveNotPossible(String, Span),
    NoFileToBeRemoved(),
    NoFileToBeMoved(),
    NoFileToBeCopied(),
    ReadingFile(String, Span),
    DidYouMean(String, Span),
    DidYouMeanCustom(String, String, Span),
    NonUtf8(Span),
    NonUtf8Custom(String, Span),
    DowncastNotPossible(String, Span),
    UnsupportedConfigValue(String, String, Span),
    MissingConfigValue(String, Span),
    NeedsPositiveValue(Span),
    GenericError(String, String, Option<Span>, Option<String>, Vec<ShellError>),
    OutsideSpannedLabeledError(String, String, String, Span),
    DeprecatedCommand(String, String, Span),
    DeprecatedParameter(String, String, Span),
    NonUnicodeInput,
    UnexpectedAbbrComponent(String),
    EvalBlockWithInput(Span, Vec<ShellError>),
    Break(Span),
    Continue(Span),
    Return(Span, Box<Value>),
    RecursionLimitReached {
        recursion_limit: u64,
        span: Option<Span>,
    },
    LazyRecordAccessFailed {
        message: String,
        column_name: String,
        span: Span,
    },
}

Expand description

The fundamental error type for the evaluation engine. These cases represent different kinds of errors the evaluator might face, along with helpful spans to label. An error renderer will take this error value and pass it into an error viewer to display to the user.

Variants§

§

OperatorMismatch

Fields

§op_span: Span

§lhs_ty: Type

§lhs_span: Span

§rhs_ty: Type

§rhs_span: Span

An operator received two arguments of incompatible types.

Resolution

Check each argument’s type and convert one or both as needed.

§

OperatorOverflow(String, Span, String)

An arithmetic operation’s resulting value overflowed its possible size.

Resolution

Check the inputs to the operation and add guards for their sizes. Integers are generally of size i64, floats are generally f64.

§

PipelineMismatch(String, Span, Span)

The pipelined input into a command was not of the expected type. For example, it might expect a string input, but received a table instead.

Resolution

Check the relevant pipeline and extract or convert values as needed.

§

OnlySupportsThisInputType(String, String, Span, Span)

§

PipelineEmpty(Span)

No input value was piped into the command.

Resolution

Only use this command to process values from a previous expression.

§

TypeMismatch(String, Span)

A command received an argument of the wrong type.

Resolution

Convert the argument type before passing it in, or change the command to accept the type.

§

TypeMismatchGenericMessage

Fields

§err_message: String

§span: Span

A command received an argument of the wrong type.

Resolution

Convert the argument type before passing it in, or change the command to accept the type.

§

UnsupportedOperator(Operator, Span)

This value cannot be used with this operator.

Resolution

Not all values, for example custom values, can be used with all operators. Either implement support for the operator on this type, or convert the type to a supported one.

§

AssignmentRequiresVar(Span)

This value cannot be used with this operator.

Resolution

Assignment requires that you assign to a variable or variable cell path.

§

AssignmentRequiresMutableVar(Span)

This value cannot be used with this operator.

Resolution

Assignment requires that you assign to a mutable variable or cell path.

§

UnknownOperator(String, Span)

An operator was not recognized during evaluation.

Resolution

Did you write the correct operator?

§

MissingParameter(String, Span)

An expected command parameter is missing.

Resolution

Add the expected parameter and try again.

§

IncompatibleParameters

Fields

§left_message: String

§left_span: Span

§right_message: String

§right_span: Span

Two parameters conflict with each other or are otherwise mutually exclusive.

Resolution

Remove one of the parameters/options and try again.

§

DelimiterError(String, Span)

There’s some issue with number or matching of delimiters in an expression.

Resolution

Check your syntax for mismatched braces, RegExp syntax errors, etc, based on the specific error message.

§

IncompatibleParametersSingle(String, Span)

An operation received parameters with some sort of incompatibility (for example, different number of rows in a table, incompatible column names, etc).

Resolution

Refer to the specific error message for details on what’s incompatible and then fix your inputs to make sure they match that way.

§

FeatureNotEnabled(Span)

This build of nushell implements this feature, but it has not been enabled.

Resolution

Rebuild nushell with the appropriate feature enabled.

§

ExternalNotSupported(Span)

You’re trying to run an unsupported external command.

Resolution

Make sure there’s an appropriate run-external declaration for this external command.

§

InvalidProbability(Span)

The given probability input is invalid. The probability must be between 0 and 1.

Resolution

Make sure the probability is between 0 and 1 and try again.

§

InvalidRange(String, String, Span)

The first value in a .. range must be compatible with the second one.

Resolution

Check to make sure both values are compatible, and that the values are enumerable in Nushell.

§

NushellFailed(String)

Catastrophic nushell failure. This reflects a completely unexpected or unrecoverable error.

Resolution

It is very likely that this is a bug. Please file an issue at https://github.com/nushell/nushell/issues with relevant information.

§

NushellFailedSpanned(String, String, Span)

Catastrophic nushell failure. This reflects a completely unexpected or unrecoverable error.

Resolution

It is very likely that this is a bug. Please file an issue at https://github.com/nushell/nushell/issues with relevant information.

§

NushellFailedHelp(String, String)

Catastrophic nushell failure. This reflects a completely unexpected or unrecoverable error.

Resolution

It is very likely that this is a bug. Please file an issue at https://github.com/nushell/nushell/issues with relevant information.

§

NushellFailedSpannedHelp(String, String, Span, String)

Catastrophic nushell failure. This reflects a completely unexpected or unrecoverable error.

Resolution

It is very likely that this is a bug. Please file an issue at https://github.com/nushell/nushell/issues with relevant information.

§

VariableNotFoundAtRuntime(Span)

A referenced variable was not found at runtime.

Resolution

Check the variable name. Did you typo it? Did you forget to declare it? Is the casing right?

§

EnvVarNotFoundAtRuntime(String, Span)

A referenced environment variable was not found at runtime.

Resolution

Check the environment variable name. Did you typo it? Did you forget to declare it? Is the casing right?

§

ModuleNotFoundAtRuntime(String, Span)

A referenced module was not found at runtime.

Resolution

Check the module name. Did you typo it? Did you forget to declare it? Is the casing right?

§

ModuleOrOverlayNotFoundAtRuntime(String, Span)

A referenced module or overlay was not found at runtime.

Resolution

Check the module name. Did you typo it? Did you forget to declare it? Is the casing right?

§

OverlayNotFoundAtRuntime(String, Span)

A referenced overlay was not found at runtime.

Resolution

Check the overlay name. Did you typo it? Did you forget to declare it? Is the casing right?

§

NotFound(Span)

The given item was not found. This is a fairly generic error that depends on context.

Resolution

This error is triggered in various places, and simply signals that “something” was not found. Refer to the specific error message for further details.

§

CantConvert(String, String, Span, Option<String>)

Failed to convert a value of one type into a different type.

Resolution

Not all values can be coerced this way. Check the supported type(s) and try again.

§

CantConvertWithValue(String, String, String, Span, Span, Option<String>)

Failed to convert a value of one type into a different type. Includes hint for what the first value is.

Resolution

Not all values can be coerced this way. Check the supported type(s) and try again.

§

EnvVarNotAString(String, Span)

An environment variable cannot be represented as a string.

Resolution

Not all types can be converted to environment variable values, which must be strings. Check the input type and try again.

§

AutomaticEnvVarSetManually(String, Span)

This environment variable cannot be set manually.

Resolution

This environment variable is set automatically by Nushell and cannot not be set manually.

§

CannotReplaceEnv(Span)

It is not possible to replace the entire environment at once

Resolution

Setting the entire environment is not allowed. Change environment variables individually instead.

§

DivisionByZero(Span)

Division by zero is not a thing.

Resolution

Add a guard of some sort to check whether a denominator input to this division is zero, and branch off if that’s the case.

§

CannotCreateRange(Span)

An error happened while tryin to create a range.

This can happen in various unexpected situations, for example if the range would loop forever (as would be the case with a 0-increment).

Resolution

Check your range values to make sure they’re countable and would not loop forever.

§

AccessBeyondEnd(usize, Span)

You attempted to access an index beyond the available length of a value.

Resolution

Check your lengths and try again.

§

InsertAfterNextFreeIndex(usize, Span)

You attempted to insert data at a list position higher than the end.

Resolution

To insert data into a list, assign to the last used index + 1.

§

AccessEmptyContent(Span)

You attempted to access an index when it’s empty.

Resolution

Check your lengths and try again.

§

AccessBeyondEndOfStream(Span)

You attempted to access an index beyond the available length of a stream.

Resolution

Check your lengths and try again.

§

IncompatiblePathAccess(String, Span)

Tried to index into a type that does not support pathed access.

Resolution

Check your types. Only composite types can be pathed into.

§

CantFindColumn(String, Span, Span)

The requested column does not exist.

Resolution

Check the spelling of your column name. Did you forget to rename a column somewhere?

§

ColumnAlreadyExists(String, Span, Span)

Attempted to insert a column into a table, but a column with that name already exists.

Resolution

Drop or rename the existing column (check rename -h) and try again.

§

NotAList(Span, Span)

The given operation can only be performed on lists.

Resolution

Check the input type to this command. Are you sure it’s a list?

§

ExternalCommand(String, String, Span)

An error happened while performing an external command.

Resolution

This error is fairly generic. Refer to the specific error message for further details.

§

UnsupportedInput(String, String, Span, Span)

An operation was attempted with an input unsupported for some reason.

Resolution

This error is fairly generic. Refer to the specific error message for further details.

§

DatetimeParseError(Span)

Failed to parse an input into a datetime value.

Resolution

Make sure your datetime input format is correct.

For example, these are some valid formats:

“5 pm”
“2020/12/4”
“2020.12.04 22:10 +2”
“2020-04-12 22:10:57 +02:00”
“2020-04-12T22:10:57.213231+02:00”
“Tue, 1 Jul 2003 10:52:37 +0200”“#

§

NetworkFailure(String, Span)

A network operation failed.

Resolution

It’s always DNS.

§

CommandNotFound(Span)

Help text for this command could not be found.

Resolution

Check the spelling for the requested command and try again. Are you sure it’s defined and your configurations are loading correctly? Can you execute it?

§

AliasNotFound(Span)

This alias could not be found

Resolution

The alias does not exist in the current scope. It might exist in another scope or overlay or be hidden.

§

FlagNotFound(String, Span)

A flag was not found.

§

FileNotFound(Span)

Failed to find a file during a nushell operation.

Resolution

Does the file in the error message exist? Is it readable and accessible? Is the casing right?

§

FileNotFoundCustom(String, Span)

Failed to find a file during a nushell operation.

Resolution

Does the file in the error message exist? Is it readable and accessible? Is the casing right?

§

PluginFailedToLoad(String)

A plugin failed to load.

Resolution

This is a fairly generic error. Refer to the specific error message for further details.

§

PluginFailedToEncode(String)

A message from a plugin failed to encode.

Resolution

This is likely a bug with the plugin itself.

§

PluginFailedToDecode(String)

A message to a plugin failed to decode.

Resolution

This is either an issue with the inputs to a plugin (bad JSON?) or a bug in the plugin itself. Fix or report as appropriate.

§