Enum routinator::output::OutputFormat

pub enum OutputFormat {
    Csv,
    ExtendedCsv,
    Json,
    Openbgpd,
    Rpsl,
    Summary,
    None,
}

The output format for VRPs.

Variants

Csv

CSV format.

Each row has the AS number, prefix, max-length, and TA.

ExtendedCsv

Extended CSV format.

Each row has URI, ASN, prefix, max-length, not before, not after.

Json

RIPE NCC Validator JSON format.

This is a JSON object with one element "roas" which is an array of objects, each with the elements "asn", "prefix", "maxLength", and "ta".

Openbgpd

OpenBGPD configuration format.

Specifically, this produces as roa-set.

Rpsl

RPSL output.

This produces a sequence of RPSL objects with various fields.

Summary

Summary output.

Produces a textual summary of the ROAs and VRPS.

None

No output.

Seriously: no output.

Methods

impl OutputFormat

pub const VALUES: &'static [&'static str]

A list of the known output formats.

pub const DEFAULT_VALUE: &'static str

The default output format.

impl OutputFormat

pub fn extra_output(self) -> bool

Returns whether this output format requires extra output.

pub fn needs_metrics(self) -> bool

Returns whether this output format requires metrics.

Important traits for OutputStream<T, F, M>

impl<T, F, M> Iterator for OutputStream<T, F, M> where
    T: AsRef<AddressOrigins>,
    F: AsRef<[Filter]>,
    M: AsRef<Metrics>,  type Item = Vec<u8>;

pub fn stream<T, F, M>(
    self,
    origins: T,
    filters: Option<F>,
    metrics: M
) -> OutputStream<T, F, M>

Creates an output stream for this format.

pub fn output<W: Write>(
    self,
    vrps: &AddressOrigins,
    filters: Option<&[Filter]>,
    metrics: &Metrics,
    target: &mut W
) -> Result<(), Error>

Outputs vrps to target in this format.

This method loggs error messages.

pub fn content_type(self) -> &'static str

Trait Implementations

impl Clone for OutputFormat

fn clone(&self) -> OutputFormat

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OutputFormat

impl Debug for OutputFormat

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

Formats the value using the given formatter.

impl FromStr for OutputFormat

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, Error>

Parses a string s to return a value of this type.