Struct pkgsrc::summary::Summaries

pub struct Summaries { /* fields omitted */ }

A collection of pkg_summary(5) entries.

Each pkg_summary entry should be separated by a single blank line.

The Write trait is implemented, and is the method by which an existing pkg_summary file can be parsed into a new Summaries.

Display is also implemented so printing the newly created collection will result in a correctly formed pkg_summary file.

Example

use pkgsrc::summary::Summaries;
use unindent::unindent;

let mut pkgsummary = Summaries::new();
let pkginfo = unindent(r#"
    BUILD_DATE=2019-08-12 15:58:02 +0100
    CATEGORIES=devel pkgtools
    COMMENT=This is a test
    DESCRIPTION=A test description
    DESCRIPTION=
    DESCRIPTION=This is a multi-line variable
    MACHINE_ARCH=x86_64
    OPSYS=Darwin
    OS_VERSION=18.7.0
    PKGNAME=testpkg-1.0
    PKGPATH=pkgtools/testpkg
    PKGTOOLS_VERSION=20091115
    SIZE_PKG=4321
    "#);
/*
 * Obviously 3 identical entries is useless, but serves as an example.
 */
let input = format!("{}\n{}\n{}\n", pkginfo, pkginfo, pkginfo);
std::io::copy(&mut input.as_bytes(), &mut pkgsummary);

/*
 * Output should match what we received.
 */
let output = format!("{}", pkgsummary);
assert_eq!(input.as_bytes(), output.as_bytes());
assert_eq!(pkgsummary.entries().len(), 3);

/*
 * Use each Summary entry to emulate pkg_info output.  This will hopefully
 * be implemented as a proper Iterator at some point.  Note that these
 * values are safe to unwrap as they are required variables and have been
 * checked to exist when creating the entries.
 */
for sum in pkgsummary.entries() {
    println!("{:20} {}", sum.pkgname().unwrap(), sum.comment().unwrap());
}

Methods

impl Summaries

Important traits for Summaries

impl Write for Summaries

pub fn new() -> Summaries

Return a new Summaries with default values.

pub fn entries(&self) -> &Vec<Summary>

Return vector of parsed Summary records.

pub fn entries_mut(&mut self) -> &mut Vec<Summary>

Return mutable vector of parsed Summary records.

Trait Implementations

impl Default for Summaries

Important traits for Summaries

impl Write for Summaries

fn default() -> Summaries

Returns the "default value" for a type.

impl Debug for Summaries

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

Formats the value using the given formatter.

impl Display for Summaries

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

Formats the value using the given formatter.

impl Write for Summaries

fn write(&mut self, input: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoSlice]) -> Result<usize, Error>

Like write, except that it writes from a slice of buffers.

fn write_all(&mut self, buf: &[u8]) -> Result<(), Error>

Attempts to write an entire buffer into this writer.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.