nushell/crates/nu-command/src/strings/encode_decode/encode_base64.rs

use super::base64::{operate, ActionType, Base64CommandArguments, CHARACTER_SET_DESC};
use nu_engine::command_prelude::*;
use nu_protocol::report_shell_warning;

#[derive(Clone)]
pub struct EncodeBase64Old;

impl Command for EncodeBase64Old {
    fn name(&self) -> &str {
        "encode base64"
    }

    fn signature(&self) -> Signature {
        Signature::build("encode base64")
            .input_output_types(vec![
                (Type::String, Type::String),
                (Type::Binary, Type::String),
                (
                    Type::List(Box::new(Type::String)),
                    Type::List(Box::new(Type::String)),
                ),
                (
                    Type::List(Box::new(Type::Binary)),
                    Type::List(Box::new(Type::String)),
                ),
                // Relaxed for heterogeneous list.
                // Should be removed as soon as the type system supports better restrictions
                (
                    Type::List(Box::new(Type::Any)),
                    Type::List(Box::new(Type::String)),
                ),
                (Type::table(), Type::table()),
                (Type::record(), Type::record()),
            ])
            .allow_variants_without_examples(true)
            .named(
                "character-set",
                SyntaxShape::String,
                CHARACTER_SET_DESC,
                Some('c'),
            )
            .rest(
                "rest",
                SyntaxShape::CellPath,
                "For a data structure input, encode data at the given cell paths.",
            )
            .category(Category::Hash)
    }

    fn description(&self) -> &str {
        "Encode a string or binary value using Base64."
    }

    fn examples(&self) -> Vec<Example> {
        vec![
            Example {
                description: "Encode binary data",
                example: "0x[09 F9 11 02 9D 74 E3 5B D8 41 56 C5 63 56 88 C0] | encode base64",
                result: Some(Value::test_string("CfkRAp1041vYQVbFY1aIwA==")),
            },
            Example {
                description: "Encode a string with default settings",
                example: "'Some Data' | encode base64",
                result: Some(Value::test_string("U29tZSBEYXRh")),
            },
            Example {
                description: "Encode a string with the binhex character set",
                example: "'Some Data' | encode base64 --character-set binhex",
                result: Some(Value::test_string(r#"8fpYC5"%BA4K"#)),
            },
        ]
    }

    fn is_const(&self) -> bool {
        true
    }

    fn run(
        &self,
        engine_state: &EngineState,
        stack: &mut Stack,
        call: &Call,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        report_shell_warning(
            engine_state,
            &ShellError::Deprecated {
                old_command: "encode base64".into(),
                new_suggestion: "the new `encode new-base64` version".into(),
                span: call.head,
                url: "`help encode new-base64`".into(),
            },
        );

        let character_set: Option<Spanned<String>> =
            call.get_flag(engine_state, stack, "character-set")?;
        let binary = call.has_flag(engine_state, stack, "binary")?;
        let cell_paths: Vec<CellPath> = call.rest(engine_state, stack, 0)?;
        let args = Base64CommandArguments {
            action_type: ActionType::Encode,
            binary,
            character_set,
        };
        operate(engine_state, call, input, cell_paths, args)
    }

    fn run_const(
        &self,
        working_set: &StateWorkingSet,
        call: &Call,
        input: PipelineData,
    ) -> Result<PipelineData, ShellError> {
        let character_set: Option<Spanned<String>> =
            call.get_flag_const(working_set, "character-set")?;
        let binary = call.has_flag_const(working_set, "binary")?;
        let cell_paths: Vec<CellPath> = call.rest_const(working_set, 0)?;
        let args = Base64CommandArguments {
            action_type: ActionType::Encode,
            binary,
            character_set,
        };
        operate(working_set.permanent(), call, input, cell_paths, args)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_examples() {
        crate::test_examples(EncodeBase64Old)
    }
}