Struct FsWorkspace 

pub struct FsWorkspace { /* private fields */ }

A Workspace backed by a directory on disk.

This is the implementation used by the lintian-brush CLI. The CLI’s fixer harness materialises the working tree to disk before invoking a fixer; this workspace then operates on that directory, and breezyshim picks up the resulting changes outside the fixer.

It contains no breezyshim types and so is safe to depend on from hosts that don’t want a Python runtime.

Implementations

impl FsWorkspace

pub fn new( base_path: impl Into<PathBuf>, package: Option<String>, version: Option<Version>, ) -> Self

Create a new tree-backed workspace.

• base_path — absolute filesystem path of the package root (the directory containing debian/).
• package, version — taken from debian/changelog by the caller. Pass None when the caller hasn’t read the changelog (e.g. tests, or tools that don’t surface package metadata to their detectors).

pub fn base_path(&self) -> &Path

The absolute on-disk root of the package.

Trait Implementations

impl Workspace for FsWorkspace

fn package(&self) -> Option<&str>

The source package name, as read from debian/changelog.

fn current_version(&self) -> Option<&Version>

The current version of the package, as read from debian/changelog.

fn parsed_control(&self) -> Result<Control, Error>

Read debian/control and return a parsed value.

fn parsed_changelog(&self) -> Result<ChangeLog, Error>

Read debian/changelog and return a parsed value.

fn parsed_copyright(&self) -> Result<Copyright, Error>

Read debian/copyright and return a parsed value.

fn parsed_upstream_metadata(&self) -> Result<YamlFile, Error>

Read debian/upstream/metadata and return its parsed YAML.

fn parsed_watch(&self) -> Result<ParsedWatchFile, Error>

Read debian/watch and return a parsed value.

fn parsed_rules(&self) -> Result<Makefile, Error>

Read debian/rules and return the parsed Makefile.

fn source_format(&self) -> Result<Option<String>, Error>

Read the trimmed contents of debian/source/format.

fn control(&self) -> Result<Box<dyn Editor<Control> + '_>, Error>

Open debian/control for editing.

fn changelog(&self) -> Result<Box<dyn Editor<ChangeLog> + '_>, Error>

Open debian/changelog for editing. See control.

fn debcargo(&self) -> Result<Option<Box<dyn Editor<DocumentMut> + '_>>, Error>

Open debian/debcargo.toml for editing.

fn read_file(&self, rel: &Path) -> Result<Option<Cow<'_, [u8]>>, Error>

Read raw bytes of an arbitrary file relative to the package root.

fn write_file(&self, rel: &Path, content: &[u8]) -> Result<(), Error>

Write raw bytes to an arbitrary file relative to the package root.

fn list_dir(&self, rel: &Path) -> Result<Option<Vec<String>>, Error>

List the entries of a directory relative to the package root.

fn walk_dir(&self, rel: &Path) -> Result<Option<Vec<PathBuf>>, Error>

Recursively walk rel, returning the relative paths of every regular file beneath it (paths are relative to the package root, not to rel).

fn file_mode(&self, rel: &Path) -> Result<Option<u32>, Error>

Read the Unix file mode of rel, or None if the file is missing.

fn base_path(&self) -> Option<&Path>

On-disk root for hosts that have one.

fn parsed_patches_series(&self) -> Result<Option<Series>, Error>

Read and parse debian/patches/series, the quilt patch series.

fn parsed_patch( &self, rel: &Path, ) -> Result<Option<(Option<PatchHeader>, Patch)>, Error>

Read a quilt patch file and return its parsed DEP-3 header together with the parsed diff.

fn parsed_debcargo(&self) -> Result<Option<DocumentMut>, Error>

Read debian/debcargo.toml and return a parsed TOML document.