nu-protocol 0.81.0

Nushell's internal protocols, including its abstract syntax tree
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35

use crate::{ShellError, Span, Value};
use std::fmt;

// Trait definition for a lazy record (where columns are evaluated on-demand)
// typetag is needed to make this implement Serialize+Deserialize... even though we should never actually serialize a LazyRecord.
// To serialize a LazyRecord, collect it into a Value::Record with collect() first.
pub trait LazyRecord<'a>: fmt::Debug + Send + Sync {
    // All column names
    fn column_names(&'a self) -> Vec<&'a str>;

    // Get 1 specific column value
    fn get_column_value(&self, column: &str) -> Result<Value, ShellError>;

    fn span(&self) -> Span;

    // Convert the lazy record into a regular Value::Record by collecting all its columns
    fn collect(&'a self) -> Result<Value, ShellError> {
        let mut cols = vec![];
        let mut vals = vec![];

        for column in self.column_names() {
            cols.push(column.into());
            let val = self.get_column_value(column)?;
            vals.push(val);
        }

        Ok(Value::Record {
            cols,
            vals,
            span: self.span(),
        })
    }

    fn clone_value(&self, span: Span) -> Value;
}