e879d4ecaf
# Description Does some misc changes to `ListStream`: - Moves it into its own module/file separate from `RawStream`. - `ListStream`s now have an associated `Span`. - This required changes to `ListStreamInfo` in `nu-plugin`. Note sure if this is a breaking change for the plugin protocol. - Hides the internals of `ListStream` but also adds a few more methods. - This includes two functions to more easily alter a stream (these take a `ListStream` and return a `ListStream` instead of having to go through the whole `into_pipeline_data(..)` route). - `map`: takes a `FnMut(Value) -> Value` - `modify`: takes a function to modify the inner stream.
150 lines
3.6 KiB
Rust
150 lines
3.6 KiB
Rust
use nu_engine::command_prelude::*;
|
|
|
|
#[derive(Clone)]
|
|
pub struct HelpEscapes;
|
|
|
|
impl Command for HelpEscapes {
|
|
fn name(&self) -> &str {
|
|
"help escapes"
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Show help on nushell string escapes."
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("help escapes")
|
|
.category(Category::Core)
|
|
.input_output_types(vec![(Type::Nothing, Type::table())])
|
|
.allow_variants_without_examples(true)
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
_engine_state: &EngineState,
|
|
_stack: &mut Stack,
|
|
call: &Call,
|
|
_input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
let head = call.head;
|
|
let escape_info = generate_escape_info();
|
|
let mut recs = vec![];
|
|
|
|
for escape in escape_info {
|
|
recs.push(Value::record(
|
|
record! {
|
|
"sequence" => Value::string(escape.sequence, head),
|
|
"output" => Value::string(escape.output, head),
|
|
},
|
|
head,
|
|
));
|
|
}
|
|
|
|
Ok(Value::list(recs, call.head).into_pipeline_data())
|
|
}
|
|
}
|
|
|
|
struct EscapeInfo {
|
|
sequence: String,
|
|
output: String,
|
|
}
|
|
|
|
fn generate_escape_info() -> Vec<EscapeInfo> {
|
|
vec![
|
|
EscapeInfo {
|
|
sequence: "\\\"".into(),
|
|
output: "\"".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\\'".into(),
|
|
output: "\'".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\\\".into(),
|
|
output: "\\".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\/".into(),
|
|
output: "/".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\(".into(),
|
|
output: "(".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\)".into(),
|
|
output: ")".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\{".into(),
|
|
output: "{".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\}".into(),
|
|
output: "}".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\$".into(),
|
|
output: "$".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\^".into(),
|
|
output: "^".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\#".into(),
|
|
output: "#".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\|".into(),
|
|
output: "|".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\~".into(),
|
|
output: "~".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\a".into(),
|
|
output: "alert bell".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\b".into(),
|
|
output: "backspace".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\e".into(),
|
|
output: "escape".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\f".into(),
|
|
output: "form feed".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\n".into(),
|
|
output: "newline (line feed)".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\r".into(),
|
|
output: "carriage return".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\t".into(),
|
|
output: "tab".into(),
|
|
},
|
|
EscapeInfo {
|
|
sequence: "\\u{X...}".into(),
|
|
output: "a single unicode character, where X... is 1-6 digits (0-9, A-F)".into(),
|
|
},
|
|
]
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod test {
|
|
#[test]
|
|
fn test_examples() {
|
|
use super::HelpEscapes;
|
|
use crate::test_examples;
|
|
test_examples(HelpEscapes {})
|
|
}
|
|
}
|