Struct Output 

pub struct Output {
    pub name: Option<String>,
    pub format: String,
    pub queries: Option<Vec<String>>,
    pub when: Option<String>,
    pub options: Map<String, Value>,
    pub destinations: Vec<Destination>,
    pub template: Option<Template>,
    pub extension: Option<String>,
    pub on_empty: Option<OnEmpty>,
    pub for_each: Option<ForEach>,
    pub file_name: Option<String>,
}

Fields

name: Option<String>

name:, so other outputs can refer to it; the default file name when set.

format: String

queries: Option<Vec<String>>

queries:: which of the Binding’s queries this output formats; None: all of them.

when: Option<String>

when:: a Jinja expression; the output is skipped when it’s false.

options: Map<String, Value>

Format options: every key except the shared ones (OUTPUT_SHARED_KEYS).

destinations: Vec<Destination>

Where the output is delivered, in order. Empty: it stays in target/.

template: Option<Template>

extension: Option<String>

extension: replaces the format’s file extension in the default file name (<report>.<extension>); Some("") means no extension. None: the format’s own.

on_empty: Option<OnEmpty>

on_empty:: what to do when every query returns no rows; None: continue.

for_each: Option<ForEach>

for_each:: one copy of the output per row of a driver query.

file_name: Option<String>

file_name: (Jinja, may use each.*): a per-row output’s file name.

Implementations

impl Output

pub fn sections(&self, query: &str) -> bool

Whether this output makes a section (a tab, a file, results.<query>) of query: it formats it, and it isn’t the output’s for_each driver.

pub fn feeds(&self, query: &str) -> bool

Whether this output formats query’s result.

pub fn is_message(&self) -> bool

pub fn label(&self, index: usize) -> String

How messages name it: “output x”, or “output 2” when unnamed.

Trait Implementations

impl Clone for Output

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Output

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Output

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Output

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Output

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Output