nu_plugin_roaring 0.1.0

A Nushell plugin for Roaring Bitmap
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51

use nu_plugin::PluginCommand;
use nu_protocol::{Category, LabeledError, PipelineData, Signature, SyntaxShape, Type, Value};

use crate::RoaringPlugin;

use super::{utils, RoaringCommand};

pub struct ListCommand;

impl nu_plugin::PluginCommand for ListCommand {
    type Plugin = RoaringPlugin;

    fn name(&self) -> &str {
        "roaring list"
    }

    fn signature(&self) -> nu_protocol::Signature {
        Signature::build(PluginCommand::name(self))
            .allow_variants_without_examples(true)
            .input_output_types(vec![
                (Type::Binary, Type::List(Box::new(Type::Int))),
                (
                    Type::Custom("RoaringBitmap".into()),
                    Type::List(Box::new(Type::Int)),
                ),
            ])
            .optional("range", SyntaxShape::Range, "the range of elements to list")
            .category(Category::Experimental)
            .filter()
    }

    fn description(&self) -> &str {
        "List the elements in a Roaring Bitmap"
    }

    fn run(
        &self,
        _plugin: &Self::Plugin,
        _engine: &nu_plugin::EngineInterface,
        call: &nu_plugin::EvaluatedCall,
        input: PipelineData,
    ) -> Result<PipelineData, LabeledError> {
        let v = call.opt(0)?;
        let r = match v {
            Some(Value::Range { val, .. }) => Some(utils::to_u32_range(val)?),
            None => None,
            _ => return Err(LabeledError::new("Expected a range")),
        };
        RoaringCommand::list(call, input, r)
    }
}