mirror of
https://github.com/nushell/nushell.git
synced 2025-03-13 15:08:43 +01:00
c747ec75c9
# Description
When implementing a `Command`, one must also import all the types
present in the function signatures for `Command`. This makes it so that
we often import the same set of types in each command implementation
file. E.g., something like this:
```rust
use nu_protocol::ast::Call;
use nu_protocol::engine::{Command, EngineState, Stack};
use nu_protocol::{
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, PipelineData,
ShellError, Signature, Span, Type, Value,
};
```
This PR adds the `nu_engine::command_prelude` module which contains the
necessary and commonly used types to implement a `Command`:
```rust
// command_prelude.rs
pub use crate::CallExt;
pub use nu_protocol::{
ast::{Call, CellPath},
engine::{Command, EngineState, Stack},
record, Category, Example, IntoInterruptiblePipelineData, IntoPipelineData, IntoSpanned,
PipelineData, Record, ShellError, Signature, Span, Spanned, SyntaxShape, Type, Value,
};
```
This should reduce the boilerplate needed to implement a command and
also gives us a place to track the breadth of the `Command` API. I tried
to be conservative with what went into the prelude modules, since it
might be hard/annoying to remove items from the prelude in the future.
Let me know if something should be included or excluded.
69 lines
1.9 KiB
Rust
69 lines
1.9 KiB
Rust
use crate::dataframe::values::NuDataFrame;
|
|
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct ListDF;
|
|
|
|
impl Command for ListDF {
|
|
fn name(&self) -> &str {
|
|
"dfr ls"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Lists stored dataframes."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build(self.name()).category(Category::Custom("dataframe".into()))
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![Example {
|
|
description: "Creates a new dataframe and shows it in the dataframe list",
|
|
example: r#"let test = ([[a b];[1 2] [3 4]] | dfr into-df);
|
|
ls"#,
|
|
result: None,
|
|
}]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let mut vals: Vec<(String, Value)> = vec![];
|
|
|
|
for overlay_frame in engine_state.active_overlays(&[]) {
|
|
for var in &overlay_frame.vars {
|
|
if let Ok(value) = stack.get_var(*var.1, call.head) {
|
|
let name = String::from_utf8_lossy(var.0).to_string();
|
|
vals.push((name, value));
|
|
}
|
|
}
|
|
}
|
|
|
|
let vals = vals
|
|
.into_iter()
|
|
.filter_map(|(name, value)| {
|
|
NuDataFrame::try_from_value(value).ok().map(|df| (name, df))
|
|
})
|
|
.map(|(name, df)| {
|
|
Value::record(
|
|
record! {
|
|
"name" => Value::string(name, call.head),
|
|
"columns" => Value::int(df.as_ref().width() as i64, call.head),
|
|
"rows" => Value::int(df.as_ref().height() as i64, call.head),
|
|
},
|
|
call.head,
|
|
)
|
|
})
|
|
.collect::<Vec<Value>>();
|
|
|
|
let list = Value::list(vals, call.head);
|
|
|
|
Ok(list.into_pipeline_data())
|
|
}
|
|
}
|