Struct pkgsrc::summary::Summary

pub struct Summary { /* fields omitted */ }

A complete pkg_summary(5) entry.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();

assert_eq!(sum.is_completed(), false);

sum.set_build_date("2019-08-12 15:58:02 +0100");
sum.set_categories("devel pkgtools");
sum.set_comment("This is a test");
sum.set_description(&["A test description".to_string(),
                      "".to_string(),
                      "This is a multi-line variable".to_string()]);
sum.set_machine_arch("x86_64");
sum.set_opsys("Darwin");
sum.set_os_version("18.7.0");
sum.set_pkgname("testpkg-1.0");
sum.set_pkgpath("pkgtools/testpkg");
sum.set_pkgtools_version("20091115");
sum.set_size_pkg(4321);

assert_eq!(sum.is_completed(), true);

/*
 * With the Display trait implemented we can simply print the Summary and
 * it will be output in the correct format, i.e.
 *
 * 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
 * ...
 */
println!("{}", sum);

Methods

impl Summary

pub fn new() -> Summary

Create a new empty Summary.

pub fn is_completed(&self) -> bool

Indicate whether all of the required variables have been set for this entry.

pub fn build_date(&self) -> Option<&str>

Returns the BuildDate value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let build_date = String::from("2019-08-12 15:58:02 +0100");

sum.set_build_date(build_date.as_str());

assert_eq!(Some(build_date.as_str()), sum.build_date());

pub fn categories(&self) -> Option<&str>

Returns the Categories value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let categories = String::from("devel pkgtools");

sum.set_categories(categories.as_str());

assert_eq!(Some(categories.as_str()), sum.categories());

pub fn comment(&self) -> Option<&str>

Returns the Comment value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let comment = String::from("This is a test");

sum.set_comment(comment.as_str());

assert_eq!(Some(comment.as_str()), sum.comment());

pub fn conflicts(&self) -> Option<&[String]>

Returns the Conflicts value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let conflicts = vec![
                    String::from("cfl-pkg1-[0-9]*"),
                    String::from("cfl-pkg2>=2.0"),
                ];

sum.set_conflicts(conflicts.as_slice());

assert_eq!(Some(conflicts.as_slice()), sum.conflicts());

pub fn depends(&self) -> Option<&[String]>

Returns the Depends value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let depends = vec![
                    String::from("dep-pkg1-[0-9]*"),
                    String::from("dep-pkg2>=2.0"),
                ];

sum.set_depends(depends.as_slice());

assert_eq!(Some(depends.as_slice()), sum.depends());

pub fn description(&self) -> Option<&[String]>

Returns the Description value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let description = vec![
                      String::from("This is a test"),
                      String::from(""),
                      String::from("This is a multi-line variable"),
                  ];

sum.set_description(description.as_slice());

assert_eq!(Some(description.as_slice()), sum.description());

pub fn file_cksum(&self) -> Option<&str>

Returns the FileCksum value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let cksum = String::from("SHA1 a4801e9b26eeb5b8bd1f54bac1c8e89dec67786a");

sum.set_file_cksum(cksum.as_str());

assert_eq!(Some(cksum.as_str()), sum.file_cksum());

pub fn file_name(&self) -> Option<&str>

Returns the FileName value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let filename = String::from("testpkg-1.0.tgz");

sum.set_file_name(filename.as_str());

assert_eq!(Some(filename.as_str()), sum.file_name());

pub fn file_size(&self) -> Option<u64>

Returns the FileSize value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let filesize = 1234;

sum.set_file_size(filesize);

assert_eq!(Some(filesize), sum.file_size());

pub fn homepage(&self) -> Option<&str>

Returns the Homepage value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let homepage = String::from("https://docs.rs/pkgsrc/");

sum.set_homepage(homepage.as_str());

assert_eq!(Some(homepage.as_str()), sum.homepage());

pub fn license(&self) -> Option<&str>

Returns the License value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let license = String::from("apache-2.0 OR modified-bsd");

sum.set_license(license.as_str());

assert_eq!(Some(license.as_str()), sum.license());

pub fn machine_arch(&self) -> Option<&str>

Returns the MachineArch value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let machine_arch = String::from("x86_64");

sum.set_machine_arch(machine_arch.as_str());

assert_eq!(Some(machine_arch.as_str()), sum.machine_arch());

pub fn opsys(&self) -> Option<&str>

Returns the Opsys value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let opsys = String::from("Darwin");

sum.set_opsys(opsys.as_str());

assert_eq!(Some(opsys.as_str()), sum.opsys());

pub fn os_version(&self) -> Option<&str>

Returns the OsVersion value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let os_version = String::from("18.7.0");

sum.set_os_version(os_version.as_str());

assert_eq!(Some(os_version.as_str()), sum.os_version());

pub fn pkg_options(&self) -> Option<&str>

Returns the PkgOptions value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkg_options = String::from("http2 idn inet6 ldap libssh2");

sum.set_pkg_options(pkg_options.as_str());

assert_eq!(Some(pkg_options.as_str()), sum.pkg_options());

pub fn pkgname(&self) -> Option<&str>

Returns the Pkgname value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkgname = String::from("testpkg-1.0");

sum.set_pkgname(pkgname.as_str());

assert_eq!(Some(pkgname.as_str()), sum.pkgname());

pub fn pkgbase(&self) -> Option<&str>

Returns the package name portion of the Pkgname value, if set. This is a required field.

Returns None if unset, or if an empty string (which would indicate a badly formed package name).

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();

sum.set_pkgname("test-pkg-1.0");
assert_eq!(sum.pkgname(), Some("test-pkg-1.0"));
assert_eq!(sum.pkgbase(), Some("test-pkg"));
assert_eq!(sum.pkgversion(), Some("1.0"));

sum.set_pkgname("-1.0");
assert_eq!(sum.pkgname(), Some("-1.0"));
assert_eq!(sum.pkgbase(), None);
assert_eq!(sum.pkgversion(), Some("1.0"));

sum.set_pkgname("test-pkg-");
assert_eq!(sum.pkgname(), Some("test-pkg-"));
assert_eq!(sum.pkgbase(), Some("test-pkg"));
assert_eq!(sum.pkgversion(), None);

pub fn pkgversion(&self) -> Option<&str>

Returns the package version portion of the Pkgname value, if set. This is a required field.

Returns None if unset, or if an empty string (which would indicate a badly formed package name).

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();

sum.set_pkgname("test-pkg-1.0");
assert_eq!(sum.pkgname(), Some("test-pkg-1.0"));
assert_eq!(sum.pkgbase(), Some("test-pkg"));
assert_eq!(sum.pkgversion(), Some("1.0"));

sum.set_pkgname("-1.0");
assert_eq!(sum.pkgname(), Some("-1.0"));
assert_eq!(sum.pkgbase(), None);
assert_eq!(sum.pkgversion(), Some("1.0"));

sum.set_pkgname("test-pkg-");
assert_eq!(sum.pkgname(), Some("test-pkg-"));
assert_eq!(sum.pkgbase(), Some("test-pkg"));
assert_eq!(sum.pkgversion(), None);

pub fn pkgpath(&self) -> Option<&str>

Returns the Pkgpath value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkgpath = String::from("pkgtools/testpkg");

sum.set_pkgpath(pkgpath.as_str());

assert_eq!(Some(pkgpath.as_str()), sum.pkgpath());

pub fn pkgtools_version(&self) -> Option<&str>

Returns the PkgtoolsVersion value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkgtools_version = String::from("20091115");

sum.set_pkgtools_version(pkgtools_version.as_str());

assert_eq!(Some(pkgtools_version.as_str()), sum.pkgtools_version());

pub fn prev_pkgpath(&self) -> Option<&str>

Returns the PrevPkgpath value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let prev_pkgpath = String::from("obsolete/testpkg");

sum.set_prev_pkgpath(prev_pkgpath.as_str());

assert_eq!(Some(prev_pkgpath.as_str()), sum.prev_pkgpath());

pub fn provides(&self) -> Option<&[String]>

Returns the Provides value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let provides = vec![
                   String::from("/opt/pkg/lib/libfoo.dylib"),
                   String::from("/opt/pkg/lib/libbar.dylib"),
                ];

sum.set_provides(provides.as_slice());

assert_eq!(Some(provides.as_slice()), sum.provides());

pub fn requires(&self) -> Option<&[String]>

Returns the Requires value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let requires = vec![
                   String::from("/usr/lib/libSystem.B.dylib"),
                   String::from("/usr/lib/libiconv.2.dylib"),
                ];

sum.set_requires(requires.as_slice());

assert_eq!(Some(requires.as_slice()), sum.requires());

pub fn size_pkg(&self) -> Option<u64>

Returns the SizePkg value, if set. This is a required field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let size_pkg = 4321;

sum.set_size_pkg(size_pkg);

assert_eq!(Some(size_pkg), sum.size_pkg());

pub fn supersedes(&self) -> Option<&[String]>

Returns the Supersedes value, if set. This is an optional field.

Returns None if unset.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let supersedes = vec![
                     String::from("oldpkg-[0-9]*"),
                     String::from("badpkg>=2.0"),
                 ];

sum.set_supersedes(supersedes.as_slice());

assert_eq!(Some(supersedes.as_slice()), sum.supersedes());

pub fn set_build_date(&mut self, build_date: &str)

Set or update the BuildDate value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let build_date = String::from("2019-08-12 15:58:02 +0100");

sum.set_build_date(build_date.as_str());

assert_eq!(Some(build_date.as_str()), sum.build_date());

pub fn set_categories(&mut self, categories: &str)

Set or update the Categories value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let categories = String::from("devel pkgtools");

sum.set_categories(categories.as_str());

assert_eq!(Some(categories.as_str()), sum.categories());

pub fn set_comment(&mut self, comment: &str)

Set or update the Comment value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let comment = String::from("This is a test");

sum.set_comment(comment.as_str());

assert_eq!(Some(comment.as_str()), sum.comment());

pub fn set_conflicts(&mut self, conflicts: &[String])

Set or update the Conflicts value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let conflicts = vec![
                    String::from("cfl-pkg1-[0-9]*"),
                    String::from("cfl-pkg2>=2.0"),
                ];

sum.set_conflicts(conflicts.as_slice());

assert_eq!(Some(conflicts.as_slice()), sum.conflicts());

pub fn set_depends(&mut self, depends: &[String])

Set or update the Depends value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let depends = vec![
                    String::from("dep-pkg1-[0-9]*"),
                    String::from("dep-pkg2>=2.0"),
                ];

sum.set_depends(depends.as_slice());

assert_eq!(Some(depends.as_slice()), sum.depends());

pub fn set_description(&mut self, description: &[String])

Set or update the Description value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let description = vec![
                      String::from("This is a test"),
                      String::from(""),
                      String::from("This is a multi-line variable"),
                  ];

sum.set_description(description.as_slice());

assert_eq!(Some(description.as_slice()), sum.description());

pub fn set_file_cksum(&mut self, file_cksum: &str)

Set or update the FileCksum value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let cksum = String::from("SHA1 a4801e9b26eeb5b8bd1f54bac1c8e89dec67786a");

sum.set_file_cksum(cksum.as_str());

assert_eq!(Some(cksum.as_str()), sum.file_cksum());

pub fn set_file_name(&mut self, file_name: &str)

Set or update the FileName value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let filename = String::from("testpkg-1.0.tgz");

sum.set_file_name(filename.as_str());

assert_eq!(Some(filename.as_str()), sum.file_name());

pub fn set_file_size(&mut self, file_size: u64)

Set or update the FileSize value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let filesize = 1234;

sum.set_file_size(filesize);

assert_eq!(Some(filesize), sum.file_size());

pub fn set_homepage(&mut self, homepage: &str)

Set or update the Homepage value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let homepage = String::from("https://docs.rs/pkgsrc/");

sum.set_homepage(homepage.as_str());

assert_eq!(Some(homepage.as_str()), sum.homepage());

pub fn set_license(&mut self, license: &str)

Set or update the License value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let license = String::from("apache-2.0 OR modified-bsd");

sum.set_license(license.as_str());

assert_eq!(Some(license.as_str()), sum.license());

pub fn set_machine_arch(&mut self, machine_arch: &str)

Set or update the MachineArch value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let machine_arch = String::from("x86_64");

sum.set_machine_arch(machine_arch.as_str());

assert_eq!(Some(machine_arch.as_str()), sum.machine_arch());

pub fn set_opsys(&mut self, opsys: &str)

Set or update the Opsys value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let opsys = String::from("Darwin");

sum.set_opsys(opsys.as_str());

assert_eq!(Some(opsys.as_str()), sum.opsys());

pub fn set_os_version(&mut self, os_version: &str)

Set or update the OsVersion value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let os_version = String::from("18.7.0");

sum.set_os_version(os_version.as_str());

assert_eq!(Some(os_version.as_str()), sum.os_version());

pub fn set_pkg_options(&mut self, pkg_options: &str)

Set or update the PkgOptions value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkg_options = String::from("http2 idn inet6 ldap libssh2");

sum.set_pkg_options(pkg_options.as_str());

assert_eq!(Some(pkg_options.as_str()), sum.pkg_options());

pub fn set_pkgname(&mut self, pkgname: &str)

Set or update the Pkgname value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkgname = String::from("testpkg-1.0");

sum.set_pkgname(pkgname.as_str());

assert_eq!(Some(pkgname.as_str()), sum.pkgname());

pub fn set_pkgpath(&mut self, pkgpath: &str)

Set or update the Pkgpath value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkgpath = String::from("pkgtools/testpkg");

sum.set_pkgpath(pkgpath.as_str());

assert_eq!(Some(pkgpath.as_str()), sum.pkgpath());

pub fn set_pkgtools_version(&mut self, pkgtools_version: &str)

Set or update the PkgtoolsVersion value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let pkgtools_version = String::from("20091115");

sum.set_pkgtools_version(pkgtools_version.as_str());

assert_eq!(Some(pkgtools_version.as_str()), sum.pkgtools_version());

pub fn set_prev_pkgpath(&mut self, prev_pkgpath: &str)

Set or update the PrevPkgpath value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let prev_pkgpath = String::from("obsolete/testpkg");

sum.set_prev_pkgpath(prev_pkgpath.as_str());

assert_eq!(Some(prev_pkgpath.as_str()), sum.prev_pkgpath());

pub fn set_provides(&mut self, provides: &[String])

Set or update the Provides value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let provides = vec![
                   String::from("/opt/pkg/lib/libfoo.dylib"),
                   String::from("/opt/pkg/lib/libbar.dylib"),
                ];

sum.set_provides(provides.as_slice());

assert_eq!(Some(provides.as_slice()), sum.provides());

pub fn set_requires(&mut self, requires: &[String])

Set or update the Requires value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let requires = vec![
                   String::from("/usr/lib/libSystem.B.dylib"),
                   String::from("/usr/lib/libiconv.2.dylib"),
                ];

sum.set_requires(requires.as_slice());

assert_eq!(Some(requires.as_slice()), sum.requires());

pub fn set_size_pkg(&mut self, size_pkg: u64)

Set or update the SizePkg value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let size_pkg = 4321;

sum.set_size_pkg(size_pkg);

assert_eq!(Some(size_pkg), sum.size_pkg());

pub fn set_supersedes(&mut self, supersedes: &[String])

Set or update the Supersedes value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let supersedes = vec![
                     String::from("oldpkg-[0-9]*"),
                     String::from("badpkg>=2.0"),
                 ];

sum.set_supersedes(supersedes.as_slice());

assert_eq!(Some(supersedes.as_slice()), sum.supersedes());

pub fn push_conflicts(&mut self, conflicts: &str)

Set or append to the Conflicts value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let conflicts = vec![
                    String::from("cfl-pkg1-[0-9]*"),
                    String::from("cfl-pkg2>=2.0"),
                ];

for conflict in &conflicts {
    sum.push_conflicts(&conflict);
}

assert_eq!(Some(conflicts.as_slice()), sum.conflicts());

pub fn push_depends(&mut self, depends: &str)

Set or append to the Depends value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();
let depends = vec![
                    String::from("dep-pkg1-[0-9]*"),
                    String::from("dep-pkg2>=2.0"),
                ];

for depend in &depends {
    sum.push_depends(&depend);
}

assert_eq!(Some(depends.as_slice()), sum.depends());

pub fn push_description(&mut self, description: &str)

Set or append to the Description value. This is a required field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();

let description = vec![
                      String::from("This is a test"),
                      String::from(""),
                      String::from("This is a multi-line variable"),
                  ];

for line in &description {
    sum.push_description(&line);
}

assert_eq!(Some(description.as_slice()), sum.description());

pub fn push_provides(&mut self, provides: &str)

Set or append to the Provides value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();

let provides = vec![
                   String::from("/opt/pkg/lib/libfoo.dylib"),
                   String::from("/opt/pkg/lib/libbar.dylib"),
                ];

for prov in &provides {
    sum.push_provides(&prov);
}

assert_eq!(Some(provides.as_slice()), sum.provides());

pub fn push_requires(&mut self, requires: &str)

Set or append to the Requires value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();

let requires = vec![
                   String::from("/usr/lib/libSystem.B.dylib"),
                   String::from("/usr/lib/libiconv.2.dylib"),
                ];

for r in &requires {
    sum.push_requires(&r);
}

assert_eq!(Some(requires.as_slice()), sum.requires());

pub fn push_supersedes(&mut self, supersedes: &str)

Set or append to the Supersedes value. This is an optional field.

Example

use pkgsrc::summary::Summary;

let mut sum = Summary::new();

let supersedes = vec![
                     String::from("oldpkg-[0-9]*"),
                     String::from("badpkg>=2.0"),
                 ];

for s in &supersedes {
    sum.push_supersedes(&s);
}

assert_eq!(Some(supersedes.as_slice()), sum.supersedes());

Trait Implementations

impl Default for Summary

fn default() -> Summary

Returns the "default value" for a type.

impl Debug for Summary

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

Formats the value using the given formatter.

impl Display for Summary

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

Formats the value using the given formatter.

impl FromStr for Summary

type Err = SummaryError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

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