Struct nu_protocol::engine::StateWorkingSet

pub struct StateWorkingSet<'a> {
    pub permanent_state: &'a EngineState,
    pub delta: StateDelta,
    pub external_commands: Vec<Vec<u8>>,
    pub type_scope: TypeScope,
    pub currently_parsed_cwd: Option<PathBuf>,
    pub parsed_module_files: Vec<PathBuf>,
    pub parse_errors: Vec<ParseError>,
}

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.

This working set is created by the parser as a way of handling declarations and scope changes that may later be merged or dropped (and not merged) depending on the needs of the code calling the parser.

Fields

permanent_state: &'a EngineState

delta: StateDelta

external_commands: Vec<Vec<u8>>

type_scope: TypeScope

currently_parsed_cwd: Option<PathBuf>

Current working directory relative to the file being parsed right now

parsed_module_files: Vec<PathBuf>

All previously parsed module files. Used to protect against circular imports.

parse_errors: Vec<ParseError>

Implementations

impl<'a> StateWorkingSet<'a>

pub fn new(permanent_state: &'a EngineState) -> Self

pub fn error(&mut self, parse_error: ParseError)

pub fn num_files(&self) -> usize

pub fn num_decls(&self) -> usize

pub fn num_blocks(&self) -> usize

pub fn num_modules(&self) -> usize

pub fn unique_overlay_names(&self) -> HashSet<&Vec<u8>>

pub fn num_overlays(&self) -> usize

pub fn add_decl(&mut self, decl: Box<dyn Command>) -> DeclId

pub fn use_decls(&mut self, decls: Vec<(Vec<u8>, DeclId)>)

pub fn add_predecl(&mut self, decl: Box<dyn Command>) -> Option<DeclId>

pub fn merge_predecl(&mut self, name: &[u8]) -> Option<DeclId>

pub fn move_predecls_to_overlay(&mut self)

pub fn hide_decl(&mut self, name: &[u8]) -> Option<DeclId>

pub fn hide_decls(&mut self, decls: &[Vec<u8>])

pub fn add_block(&mut self, block: Block) -> BlockId

pub fn add_module( &mut self, name: &str, module: Module, comments: Vec<Span> ) -> ModuleId

pub fn next_span_start(&self) -> usize

pub fn global_span_offset(&self) -> usize

pub fn files(&'a self) -> impl Iterator<Item = &(String, usize, usize)>

pub fn get_filename(&self, file_id: usize) -> String

pub fn get_file_source(&self, file_id: usize) -> String

pub fn add_file(&mut self, filename: String, contents: &[u8]) -> usize

pub fn get_span_for_file(&self, file_id: usize) -> Span

pub fn get_span_contents(&self, span: Span) -> &[u8]

pub fn enter_scope(&mut self)

pub fn exit_scope(&mut self)

pub fn find_predecl(&self, name: &[u8]) -> Option<DeclId>

pub fn find_decl(&self, name: &[u8], input: &Type) -> Option<DeclId>

pub fn find_module(&self, name: &[u8]) -> Option<ModuleId>

pub fn contains_decl_partial_match(&self, name: &[u8]) -> bool

pub fn next_var_id(&self) -> VarId

pub fn find_variable(&self, name: &[u8]) -> Option<VarId>

pub fn find_variable_in_current_frame(&self, name: &[u8]) -> Option<VarId>

pub fn add_variable( &mut self, name: Vec<u8>, span: Span, ty: Type, mutable: bool ) -> VarId

pub fn get_cwd(&self) -> String

pub fn get_env_var(&self, name: &str) -> Option<&Value>

pub fn get_config(&self) -> &Config

pub fn list_env(&self) -> Vec<String>

pub fn set_variable_type(&mut self, var_id: VarId, ty: Type)

pub fn add_constant(&mut self, var_id: VarId, val: Value)

pub fn find_constant(&self, var_id: VarId) -> Option<&Value>

pub fn get_variable(&self, var_id: VarId) -> &Variable

pub fn get_variable_if_possible(&self, var_id: VarId) -> Option<&Variable>

pub fn get_decl(&self, decl_id: DeclId) -> &Box<dyn Command>

pub fn get_decl_mut(&mut self, decl_id: DeclId) -> &mut Box<dyn Command>

pub fn find_commands_by_predicate( &self, predicate: impl Fn(&[u8]) -> bool ) -> Vec<(Vec<u8>, Option<String>)>

pub fn get_block(&self, block_id: BlockId) -> &Block

pub fn get_module(&self, module_id: ModuleId) -> &Module

pub fn get_block_mut(&mut self, block_id: BlockId) -> &mut Block

pub fn has_overlay(&self, name: &[u8]) -> bool

pub fn find_overlay(&self, name: &[u8]) -> Option<&OverlayFrame>

pub fn last_overlay_name(&self) -> &Vec<u8>

pub fn last_overlay(&self) -> &OverlayFrame

pub fn last_overlay_mut(&mut self) -> &mut OverlayFrame

pub fn decls_of_overlay(&self, name: &[u8]) -> HashMap<Vec<u8>, DeclId>

Collect all decls that belong to an overlay

pub fn add_overlay( &mut self, name: Vec<u8>, origin: ModuleId, decls: Vec<(Vec<u8>, DeclId)>, prefixed: bool )

pub fn remove_overlay(&mut self, name: &[u8], keep_custom: bool)

pub fn render(self) -> StateDelta

pub fn build_usage(&self, spans: &[Span]) -> (String, String)

pub fn find_block_by_span(&self, span: Span) -> Option<Block>

Trait Implementations

impl<'a> SourceCode for &StateWorkingSet<'a>

fn read_span<'b>( &'b self, span: &SourceSpan, context_lines_before: usize, context_lines_after: usize ) -> Result<Box<dyn SpanContents<'_> + 'b>, MietteError>

Read the bytes for a specific span from this SourceCode, keeping a certain number of lines before and after the span as context.