asimov-patterns 25.5.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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

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

//! RDF import: the reader marker trait and source/output format options.

use crate::Execute;
use alloc::{string::String, vec::Vec};
use bon::Builder;

/// An importer that maps a document or byte stream into an RDF graph or dataset.
///
/// Source data may use an RDF or non-RDF format. The program defines supported
/// inputs and their mappings, including vocabulary, base-IRI handling, and
/// identifier generation. This role describes a data-import operation, not an
/// implementation of Rust's byte-reading traits.
///
/// # Command-line contract
///
/// `PROGRAM [OPTIONS] [INPUT-FILE [OUTPUT-FILE]]`
///
/// Input and output default to stdin and stdout. A single operand selects
/// input; two select input then output, with `-` denoting a standard stream.
/// [`ReaderOptions`] defaults to automatic input-format detection and `jsonl`
/// output. The program must document its detection procedure and fail if it
/// cannot select a supported input format.
///
/// `T` is the implementation's imported-result representation. See
/// [`crate::programs`] for links to concrete execution behavior and the
/// [reader specification][spec].
///
/// [spec]: https://asimov-specs.github.io/program-patterns/#reader
pub trait Reader<T>: Execute<T> {}

/// Source and RDF output formats for a [`Reader`], plus additional arguments.
///
/// `Default` leaves formats unset and `other` empty, delegating detection and
/// output defaults to the program. Configuration does not perform detection,
/// validate format support, or transform the input.
///
/// # Examples
///
/// ```rust
/// use asimov_patterns::ReaderOptions;
///
/// let options = ReaderOptions::builder()
///     .input("auto")
///     .output("jsonl")
///     .build();
/// ```
#[derive(Clone, Debug, Default, Eq, Hash, Ord, PartialEq, PartialOrd, Builder)]
#[builder(derive(Debug), on(String, into))]
pub struct ReaderOptions {
    /// Additional arguments, including optional source and RDF output file operands.
    ///
    /// The wrapper appends these after generated format options. Put extension
    /// options before files; each string is one literal argument. See
    /// [`crate::programs`] for operand ordering and standard-stream selection.
    #[builder(field)]
    pub other: Vec<String>,

    /// Source format passed as `--input=FORMAT` (`-i` in the CLI).
    ///
    /// `None` omits the option; the specified default is `auto`, requesting the
    /// program's documented detection procedure. An explicit concrete format
    /// takes precedence over detection. This is not an input filename.
    pub input: Option<String>,

    /// RDF serialization passed as `--output=FORMAT` (`-o` in the CLI).
    ///
    /// `None` omits the option; the specified program default is `jsonl`.
    /// This selects a serialization, not an output file or a source-to-RDF mapping.
    pub output: Option<String>,
}

impl<S: reader_options_builder::State> ReaderOptionsBuilder<S> {
    /// Appends one literal argument to [`ReaderOptions::other`], preserving order.
    pub fn other(mut self, flag: impl Into<String>) -> Self {
        self.other.push(flag.into());
        self
    }

    /// Appends a present argument to [`ReaderOptions::other`]; `None` adds nothing.
    pub fn maybe_other(mut self, flag: Option<impl Into<String>>) -> Self {
        if let Some(flag) = flag {
            self.other.push(flag.into());
        }
        self
    }
}