Struct WatchFile 

pub struct WatchFile(/* private fields */);

A watch file in format 5 (RFC822/deb822 style)

Implementations

impl WatchFile

pub fn as_deb822(&self) -> &Deb822

Returns a reference to the underlying deb822 document.

pub fn snapshot(&self) -> Self

Capture an independent snapshot of this watch file. See crate::parse::ParsedWatchFile::snapshot for semantics.

pub fn tree_eq(&self, other: &Self) -> bool

Returns true iff the syntax trees of self and other are value-equal. An O(1) pointer-identity fast path makes this free for trees that still share state with a recent snapshot().

pub fn new() -> Self

Create a new empty format 5 watch file

pub fn version(&self) -> u32

Returns the version of the watch file (always 5 for this type)

pub fn defaults(&self) -> Option<Paragraph>

Returns the defaults paragraph if it exists. The defaults paragraph is the second paragraph (after Version) if it has no Source field.

pub fn entries(&self) -> impl Iterator<Item = Entry> + '_

Returns an iterator over all entries in the watch file. The first paragraph contains defaults, subsequent paragraphs are entries.

pub fn inner(&self) -> &Deb822

Get the underlying Deb822 object

pub fn inner_mut(&mut self) -> &mut Deb822

Get a mutable reference to the underlying Deb822 object

pub fn add_entry(&mut self, source: &str, matching_pattern: &str) -> Entry

Add a new entry to the watch file with the given source and matching pattern. Returns the newly created Entry.

Example

use debian_watch::deb822::WatchFile;
use debian_watch::WatchOption;

let mut wf = WatchFile::new();
let mut entry = wf.add_entry("https://github.com/foo/bar/tags", ".*/v?([\\d.]+)\\.tar\\.gz");
entry.set_option(WatchOption::Component("upstream".to_string()));

Trait Implementations

impl Clone for WatchFile

fn clone(&self) -> WatchFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WatchFile

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

Formats the value using the given formatter.

impl Default for WatchFile

fn default() -> Self

Returns the “default value” for a type.

impl Display for WatchFile

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

Formats the value using the given formatter.

impl FromStr for WatchFile

type Err = ParseError

The associated error which can be returned from parsing.

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

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