nushell/crates/nu-command/src/debug/metadata_set.rs
Ian Manske 399a7c8836
Add and use new Signals struct (#13314)
# Description
This PR introduces a new `Signals` struct to replace our adhoc passing
around of `ctrlc: Option<Arc<AtomicBool>>`. Doing so has a few benefits:
- We can better enforce when/where resetting or triggering an interrupt
is allowed.
- Consolidates `nu_utils::ctrl_c::was_pressed` and other ad-hoc
re-implementations into a single place: `Signals::check`.
- This allows us to add other types of signals later if we want. E.g.,
exiting or suspension.
- Similarly, we can more easily change the underlying implementation if
we need to in the future.
- Places that used to have a `ctrlc` of `None` now use
`Signals::empty()`, so we can double check these usages for correctness
in the future.
2024-07-07 22:29:01 +00:00

105 lines
3.4 KiB
Rust

use nu_engine::command_prelude::*;
use nu_protocol::DataSource;
#[derive(Clone)]
pub struct MetadataSet;
impl Command for MetadataSet {
fn name(&self) -> &str {
"metadata set"
}
fn usage(&self) -> &str {
"Set the metadata for items in the stream."
}
fn signature(&self) -> nu_protocol::Signature {
Signature::build("metadata set")
.input_output_types(vec![(Type::Any, Type::Any)])
.switch(
"datasource-ls",
"Assign the DataSource::Ls metadata to the input",
Some('l'),
)
.named(
"datasource-filepath",
SyntaxShape::Filepath,
"Assign the DataSource::FilePath metadata to the input",
Some('f'),
)
.named(
"content-type",
SyntaxShape::String,
"Assign content type metadata to the input",
Some('c'),
)
.allow_variants_without_examples(true)
.category(Category::Debug)
}
fn run(
&self,
engine_state: &EngineState,
stack: &mut Stack,
call: &Call,
input: PipelineData,
) -> Result<PipelineData, ShellError> {
let head = call.head;
let ds_fp: Option<String> = call.get_flag(engine_state, stack, "datasource-filepath")?;
let ds_ls = call.has_flag(engine_state, stack, "datasource-ls")?;
let content_type: Option<String> = call.get_flag(engine_state, stack, "content-type")?;
let signals = engine_state.signals().clone();
let metadata = input
.metadata()
.clone()
.unwrap_or_default()
.with_content_type(content_type);
match (ds_fp, ds_ls) {
(Some(path), false) => Ok(input.into_pipeline_data_with_metadata(
head,
signals,
metadata.with_data_source(DataSource::FilePath(path.into())),
)),
(None, true) => Ok(input.into_pipeline_data_with_metadata(
head,
signals,
metadata.with_data_source(DataSource::Ls),
)),
_ => Ok(input.into_pipeline_data_with_metadata(head, signals, metadata)),
}
}
fn examples(&self) -> Vec<Example> {
vec![
Example {
description: "Set the metadata of a table literal",
example: "[[name color]; [Cargo.lock '#ff0000'] [Cargo.toml '#00ff00'] [README.md '#0000ff']] | metadata set --datasource-ls",
result: None,
},
Example {
description: "Set the metadata of a file path",
example: "'crates' | metadata set --datasource-filepath $'(pwd)/crates' | metadata",
result: None,
},
Example {
description: "Set the metadata of a file path",
example: "'crates' | metadata set --content-type text/plain | metadata",
result: Some(Value::record(record!("content_type" => Value::string("text/plain", Span::test_data())), Span::test_data())),
},
]
}
}
#[cfg(test)]
mod test {
use crate::{test_examples_with_commands, Metadata};
use super::*;
#[test]
fn test_examples() {
test_examples_with_commands(MetadataSet {}, &[&Metadata {}])
}
}