Struct WatchFile 

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

A node in the syntax tree for $ast

Implementations

impl WatchFile

pub fn text_range(&self) -> TextRange

Byte range covered by this node in the source buffer.

Useful for editors that need to map a logical concept (an option, a URL, a matching pattern) back to the exact span it occupies — e.g. to filter LSP diagnostics by which part of a watch entry was edited.

pub fn line(&self) -> usize

Get the line number (0-indexed) where this node starts.

pub fn column(&self) -> usize

Get the column number (0-indexed, in bytes) where this node starts.

pub fn line_col(&self) -> (usize, usize)

Get both line and column (0-indexed) where this node starts. Returns (line, column) where column is measured in bytes from the start of the line.

impl WatchFile

pub fn syntax(&self) -> &SyntaxNode<Lang>

Access the underlying syntax node

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(version: Option<u32>) -> WatchFile

Create a new watch file with specified version

pub fn version_node(&self) -> Option<Version>

Returns the version AST node of the watch file.

pub fn version(&self) -> u32

Returns the version of the watch file.

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

Returns an iterator over all entries in the watch file.

pub fn set_version(&mut self, new_version: u32)

Set the version of the watch file.

pub fn add_entry(&mut self, entry: Entry) -> Entry

Add an entry to the watch file.

Appends a new entry to the end of the watch file.

Examples

use debian_watch::linebased::{WatchFile, EntryBuilder};

let mut wf = WatchFile::new(Some(4));

// Add an entry using EntryBuilder
let entry = EntryBuilder::new("https://github.com/example/tags")
    .matching_pattern(".*/v?(\\d\\S+)\\.tar\\.gz")
    .build();
wf.add_entry(entry);

// Or use the builder pattern directly
wf.add_entry(
    EntryBuilder::new("https://example.com/releases")
        .matching_pattern(".*/(\\d+\\.\\d+)\\.tar\\.gz")
        .opt("compression", "xz")
        .version_policy("debian")
        .build()
);

pub fn from_reader<R: Read>(reader: R) -> Result<WatchFile, ParseError>

Read a watch file from a Read object.

pub fn from_reader_relaxed<R: Read>(r: R) -> Result<Self, Error>

Read a watch file from a Read object, allowing syntax errors.

pub fn from_str_relaxed(s: &str) -> Self

Parse a debian watch file from a string, allowing syntax errors.

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 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.

impl Hash for WatchFile

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for WatchFile

fn eq(&self, other: &WatchFile) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for WatchFile

impl StructuralPartialEq for WatchFile