Skip to main content

CoverageRun

Struct CoverageRun 

Source
pub struct CoverageRun { /* private fields */ }
Expand description

Configuration for a coverage run.

Wraps cargo llvm-cov --json --summary-only. Use the builder methods to scope the run (working directory, workspace toggle, excludes, features), then call execute to invoke the subprocess and parse the result.

§Example

use dev_coverage::CoverageRun;

let run = CoverageRun::new("my-crate", "0.1.0")
    .workspace()
    .exclude("tests/*")
    .all_features();

let _result = run.execute().unwrap();

Implementations§

Source§

impl CoverageRun

Source

pub fn new(name: impl Into<String>, version: impl Into<String>) -> Self

Begin a coverage run for the given crate name and version.

name and version are descriptive — they identify the subject in the produced dev-report::Report. They do NOT need to match the package being measured (that is determined by cargo’s own resolution from the working directory).

Source

pub fn in_dir(self, dir: impl Into<PathBuf>) -> Self

Run cargo llvm-cov from dir instead of the current directory.

Source

pub fn subject(&self) -> &str

Descriptive subject name passed in via new.

Source

pub fn subject_version(&self) -> &str

Descriptive subject version passed in via new.

Source

pub fn workspace(self) -> Self

Pass --workspace so every workspace member is measured.

Source

pub fn exclude(self, pattern: impl Into<String>) -> Self

Pass --exclude <pattern>. May be called multiple times.

Source

pub fn feature(self, name: impl Into<String>) -> Self

Add a specific feature to enable. May be called multiple times.

Source

pub fn all_features(self) -> Self

Pass --all-features.

Source

pub fn no_default_features(self) -> Self

Pass --no-default-features.

Source

pub fn per_file(self) -> Self

Request a per-file breakdown (drops --summary-only).

Default is summary-only — much smaller JSON, faster parse. Enable this when you need CoverageResult::files populated.

Source

pub fn execute(&self) -> Result<CoverageResult, CoverageError>

Execute the run.

Returns a CoverageResult on success, or a CoverageError describing what went wrong (missing tool, subprocess failure, parse failure).

Trait Implementations§

Source§

impl Clone for CoverageRun

Source§

fn clone(&self) -> CoverageRun

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for CoverageRun

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.