a5c604c283
# Description Working on uniformizing the ending messages regarding methods usage() and extra_usage(). This is related to the issue https://github.com/nushell/nushell/issues/5066 after discussing it with @jntrnr # User-Facing Changes None. # Tests + Formatting Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used -A clippy::needless_collect` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass # After Submitting If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date.
88 lines
2.5 KiB
Rust
88 lines
2.5 KiB
Rust
use super::base64::{operate, ActionType, CHARACTER_SET_DESC};
|
|
use nu_protocol::ast::Call;
|
|
use nu_protocol::engine::{Command, EngineState, Stack};
|
|
use nu_protocol::{
|
|
Category, Example, PipelineData, ShellError, Signature, Span, SyntaxShape, Type, Value,
|
|
};
|
|
|
|
#[derive(Clone)]
|
|
pub struct DecodeBase64;
|
|
|
|
impl Command for DecodeBase64 {
|
|
fn name(&self) -> &str {
|
|
"decode base64"
|
|
}
|
|
|
|
fn signature(&self) -> Signature {
|
|
Signature::build("decode base64")
|
|
.input_output_types(vec![
|
|
(Type::String, Type::String),
|
|
(Type::String, Type::Binary),
|
|
])
|
|
.vectorizes_over_list(true)
|
|
.named(
|
|
"character-set",
|
|
SyntaxShape::String,
|
|
CHARACTER_SET_DESC,
|
|
Some('c'),
|
|
)
|
|
.switch(
|
|
"binary",
|
|
"Output a binary value instead of decoding payload as UTF-8",
|
|
Some('b'),
|
|
)
|
|
.rest(
|
|
"rest",
|
|
SyntaxShape::CellPath,
|
|
"For a data structure input, decode data at the given cell paths",
|
|
)
|
|
.category(Category::Hash)
|
|
}
|
|
|
|
fn usage(&self) -> &str {
|
|
"Base64 decode a value."
|
|
}
|
|
|
|
fn extra_usage(&self) -> &str {
|
|
r#"Will attempt to decode binary payload as an UTF-8 string by default. Use the `--binary(-b)` argument to force binary output."#
|
|
}
|
|
|
|
fn examples(&self) -> Vec<Example> {
|
|
vec![
|
|
Example {
|
|
description: "Base64 decode a value and output as UTF-8 string",
|
|
example: "'U29tZSBEYXRh' | decode base64",
|
|
result: Some(Value::test_string("Some Data")),
|
|
},
|
|
Example {
|
|
description: "Base64 decode a value and output as binary",
|
|
example: "'U29tZSBEYXRh' | decode base64 --binary",
|
|
result: Some(Value::binary(
|
|
[0x53, 0x6f, 0x6d, 0x65, 0x20, 0x44, 0x61, 0x74, 0x61],
|
|
Span::test_data(),
|
|
)),
|
|
},
|
|
]
|
|
}
|
|
|
|
fn run(
|
|
&self,
|
|
engine_state: &EngineState,
|
|
stack: &mut Stack,
|
|
call: &Call,
|
|
input: PipelineData,
|
|
) -> Result<PipelineData, ShellError> {
|
|
operate(ActionType::Decode, engine_state, stack, call, input)
|
|
}
|
|
}
|
|
|
|
#[cfg(test)]
|
|
mod tests {
|
|
use super::*;
|
|
|
|
#[test]
|
|
fn test_examples() {
|
|
crate::test_examples(DecodeBase64)
|
|
}
|
|
}
|