Module command_prelude

Source

Re-exports§

pub use crate::CallExt;

Modules§

record
Our insertion ordered map-type Record

Macros§

record

Structs§

ByteStream
A potentially infinite, interruptible stream of bytes.
Call
This is a HACK to help Command support both the old AST evaluator and the new IR evaluator at the same time. It should be removed once we are satisfied with the new evaluator.
CellPath
Represents the potentially nested access to fields/cells of a container type
EngineState
The core global engine state. This includes all global definitions as well as any global state that will persist for the whole session.
Example
IoError
Represents an I/O error in the ShellError::Io variant.
Record
Signature
Signature information of a Command
Span
Spans are a global offset across all seen files, which are cached in the engine’s state. The start and end offset together make the inclusive start/exclusive end pair for where to underline to highlight a given point of interest.
Spanned
A spanned area of interest, generic over what kind of thing is of interest
Stack
A runtime value stack used during evaluation
StateWorkingSet
A temporary extension to the global state. This handles bridging between the global state and the additional declarations and scope changes that are not yet part of the global scope.

Enums§

ByteStreamType
Optional type color for ByteStream, which determines type compatibility.
Category
Command categories
PipelineData
The foundational abstraction for input and output to commands
ShellError
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.
SyntaxShape
The syntactic shapes that describe how a sequence should be parsed.
Type
Value
Core structured values that pass through the pipeline in Nushell.

Traits§

Command
ErrSpan
An extension trait for Result, which adds a span to the error type.
IntoInterruptiblePipelineData
IntoPipelineData
IntoSpanned
Helper trait to create Spanned more ergonomically.
IntoValue
A trait for converting a value into a Value.

Derive Macros§

IntoValue
Derive macro generating an impl of the trait IntoValue.