Struct SummaryBuilder

Source

pub struct SummaryBuilder { /* private fields */ }

Expand description

Builder for constructing a Summary from VARIABLE=VALUE lines.

§Example

use pkgsrc::summary::SummaryBuilder;

let path = concat!(env!("CARGO_MANIFEST_DIR"), "/tests/data/summary/mktool.txt");
let input = std::fs::read_to_string(path).expect("failed to read mktool.txt");

assert_eq!(
    SummaryBuilder::new()
        .vars(input.lines())
        .build()
        .expect("build failed")
        .pkgname(),
    "mktool-1.4.2"
);

Implementations§

Source §

impl SummaryBuilder

Source

pub fn new() -> Self

Create a new empty SummaryBuilder.

Source

pub fn var(self, line: impl AsRef<str>) -> Self

Add a single VARIABLE=VALUE line.

This method is infallible; validation occurs when build is called.

Prefer vars when adding multiple variables.

Source

pub fn vars<I, S>(self, lines: I) -> Self
where I: IntoIterator<Item = S>, S: AsRef<str>,

Add VARIABLE=VALUE lines.

This method is infallible; validation occurs when build is called.

§Example

use pkgsrc::summary::SummaryBuilder;

let path = concat!(env!("CARGO_MANIFEST_DIR"), "/tests/data/summary/mktool.txt");
let input = std::fs::read_to_string(path).expect("failed to read mktool.txt");

assert_eq!(
    SummaryBuilder::new()
        .vars(input.lines())
        .build()
        .expect("build failed")
        .pkgname(),
    "mktool-1.4.2"
);

Source

pub fn allow_unknown(self, yes: bool) -> Self

Allow unknown variables instead of returning an error.

Source

pub fn allow_incomplete(self, yes: bool) -> Self

Allow incomplete entries missing required fields.

Source

pub fn build(self) -> Result<Summary>

Validate and finalize the Summary.

Parses all added variables, validates that all required fields are present, and returns the completed Summary.

§Errors

Returns Error if the input is invalid. Applications may want to ignore Error::UnknownVariable if they wish to be future-proof against potential new additions to the pkg_summary format.

§Examples

use pkgsrc::summary::{Error, SummaryBuilder};

let path = concat!(env!("CARGO_MANIFEST_DIR"), "/tests/data/summary/mktool.txt");
let input = std::fs::read_to_string(path).expect("failed to read mktool.txt");

// Valid pkg_summary data.
assert_eq!(
    SummaryBuilder::new()
        .vars(input.lines())
        .build()
        .expect("build failed")
        .pkgname(),
    "mktool-1.4.2"
);

// Missing required fields.
assert!(matches!(
    SummaryBuilder::new()
        .vars(["PKGNAME=testpkg-1.0", "COMMENT=Test"])
        .build(),
    Err(Error::Incomplete { .. })
));

// Contains a line not in VARIABLE=VALUE format.
assert!(matches!(
    SummaryBuilder::new()
        .vars(["not a valid line"])
        .build(),
    Err(Error::ParseLine { .. })
));

// Unknown variable name.
assert!(matches!(
    SummaryBuilder::new()
        .vars(["UNKNOWN=value"])
        .build(),
    Err(Error::UnknownVariable { .. })
));

// Invalid integer value (with all other required fields present).
assert!(matches!(
    SummaryBuilder::new()
        .vars([
            "BUILD_DATE=2019-08-12",
            "CATEGORIES=devel",
            "COMMENT=test",
            "DESCRIPTION=test",
            "MACHINE_ARCH=x86_64",
            "OPSYS=NetBSD",
            "OS_VERSION=9.0",
            "PKGNAME=test-1.0",
            "PKGPATH=devel/test",
            "PKGTOOLS_VERSION=20091115",
            "SIZE_PKG=not_a_number",
        ])
        .build(),
    Err(Error::ParseInt { .. })
));