asimov-patterns 25.6.0

ASIMOV Software Development Kit (SDK) for Rust
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
52
53
54
55
56
57
58
59
60
61

// This is free and unencumbered software released into the public domain.

//! Shared output filtering options.

use alloc::string::String;
use bon::Builder;

#[cfg(feature = "clap")]
const HELP_JEV: &str = r#"Filter output using a Jev noul: an assertion evaluated as true or false.

Use an assertion such as "The name is Ukrainian", rather than a question.
Jev filtering is applied before --jq."#;

#[cfg(feature = "clap")]
const HELP_JQ: &str = r#"Filter and/or transform JSON-LD output using a jq expression.

For example, "select(.name)". When --jev is also specified, jq is applied after
Jev filtering."#;

/// Output filtering requests for host commands.
///
/// Flatten this alongside [`crate::ListerOptions`] in a host's Clap arguments.
/// Both fields default to `None`, leaving output unfiltered. The host applies
/// Jev before jq and supplies the evaluators and any required credentials.
/// This type stores expressions without compiling or evaluating them;
/// `asimov-runner` does not perform this filtering.
#[derive(Clone, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd, Builder)]
#[builder(derive(Debug), on(String, into))]
#[cfg_attr(feature = "clap", derive(clap::Args))]
#[cfg_attr(feature = "clap", command(about = None, long_about = None))]
pub struct FilteringOptions {
    /// Filter output using a Jev noul (an assertion evaluated as true or false).
    ///
    /// The `NOUL` argument should be an assertion, such as
    /// `The name is Ukrainian`, rather than a question. Applied by the host
    /// before [`Self::jq`].
    #[cfg_attr(
        feature = "clap",
        clap(
            long,
            value_name = "NOUL",
            help = "Filter output using a Jev noul (an assertion evaluated as true or false)",
            long_help = HELP_JEV
        )
    )]
    pub jev: Option<String>,

    /// Filter and/or transform JSON-LD output using a jq expression.
    ///
    /// For example, `select(.name)`. Applied by the host after [`Self::jev`].
    #[cfg_attr(
        feature = "clap",
        clap(
            long,
            value_name = "EXPR",
            help = "Filter and/or transform JSON-LD output using a jq expression",
            long_help = HELP_JQ
        )
    )]
    pub jq: Option<String>,
}