Struct Document 

pub struct Document<'a> {
    pub preamble: Preamble<'a>,
    pub plan: Plan<'a>,
    pub body: Vec<Statement<'a>>,
}

A Document represents the root of any TAP document. It’s the main point of interaction for users of this API.

Fields

preamble: Preamble<'a>

The document’s preamble.

plan: Plan<'a>

The document’s top-level plan declaration.

body: Vec<Statement<'a>>

The document’s top-level Body as a collection of Statements. Some Statements, like Subtest may declare nested Bodys.

Implementations

impl<'a> Document<'a>

pub fn parse(pairs: Pairs<'a, Rule>) -> Result<Self>

pub fn parse_from_str(content: &'a str) -> Result<Self>

Parse Document from a &str.

Examples

Parsing a TAP document may look like this:

use tapconsooomer::Document;

let content = concat!(
    "TAP version 14\n",
    "1..1\n",
    "ok 1 - foo()\n",
);
let doc = Document::parse_from_str(content).expect("Parser error");
assert_eq!(doc.preamble.version, "14");
assert_eq!(doc.body.len(), 1);

The order in which Body and Plan are declared is unimportant:

use tapconsooomer::Document;

let content = concat!(
    "TAP version 14\n",
    "ok 1 - foo()\n",
    "ok 2 - bar()\n",
    "1..2\n",
);
let doc = Document::parse_from_str(content).expect("Parser error");
assert_eq!(doc.preamble.version, "14");
assert_eq!(doc.body.len(), 2);

Trait Implementations

impl<'a> Debug for Document<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for Document<'a>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.