glcov - v0.4.0

glcov/coverage

Types

FileCoverage

</> 
pub type FileCoverage {
  FileCoverage(
    module: String,
    source: String,
    lines: List(#(Int, Bool)),
    functions: List(FunctionCoverage),
  )
}

Constructors 

  • FileCoverage(
  module: String,
  source: String,
  lines: List(#(Int, Bool)),
  functions: List(FunctionCoverage),
)

FunctionCoverage

</> 
pub type FunctionCoverage {
  FunctionCoverage(
    name: String,
    arity: Int,
    line: Int,
    calls: Int,
  )
}

Constructors 

  • FunctionCoverage(name: String, arity: Int, line: Int, calls: Int)

Report

</> 
pub type Report {
  Report(files: List(FileCoverage))
}

Constructors

Values

covered_functions

</> 
pub fn covered_functions(report: Report) -> Int

covered_lines

</> 
pub fn covered_lines(report: Report) -> Int

file_covered_count

</> 
pub fn file_covered_count(lines: List(#(Int, Bool))) -> Int

file_percentage_bp

</> 
pub fn file_percentage_bp(lines: List(#(Int, Bool))) -> Int

file_percentage_string

</> 
pub fn file_percentage_string(
  lines: List(#(Int, Bool)),
) -> String

format_counts

</> 
pub fn format_counts(covered: Int, total: Int) -> String

from_modules

</> 
pub fn from_modules(
  modules: List(#(String, String, List(#(Int, Bool)))),
) -> Report

Build a report from {module, source, [{line, covered}]} entries.

Sources are already relative to the project root by the time they reach this function; empty sources are dropped and all other files are sorted for deterministic output.

from_modules_with_functions

</> 
pub fn from_modules_with_functions(
  modules: List(#(String, String, List(#(Int, Bool)))),
  function_rows: List(#(String, String, Int, Int, Int)),
) -> Report

Build a report with line and function coverage.

Function rows are {source, name, line, arity, calls}.

from_source_lines

</> 
pub fn from_source_lines(
  sources: List(#(String, List(#(Int, Bool)))),
) -> Report

line_count

</> 
pub fn line_count(lines: List(#(Int, Bool))) -> Int

meets_minimum

</> 
pub fn meets_minimum(report: Report, min_bp: Int) -> Bool

Exact comparison, independent of floating point rounding.

percentage_bp

</> 
pub fn percentage_bp(report: Report) -> Int

Total coverage in basis points, rounded down. 0 when there is no data.

percentage_string

</> 
pub fn percentage_string(report: Report) -> String

total_functions

</> 
pub fn total_functions(report: Report) -> Int

total_lines

</> 
pub fn total_lines(report: Report) -> Int

uncovered_lines

</> 
pub fn uncovered_lines(report: Report) -> Int
✨ Search Document