Struct LineSegment 

pub struct LineSegment { /* private fields */ }

Describes a constant contribution spanning an inclusive set of one-based line numbers.

Implementations

impl LineSegment

pub fn new( start_line: usize, end_line: usize, value: f64, ) -> Result<Self, SegmentError>

Creates a new line segment.

Line numbers are one-based and ranges are inclusive.

Examples

use whitaker_common::complexity_signal::LineSegment;

let segment = LineSegment::new(3, 5, 1.25).expect("segment should be valid");
assert_eq!(segment.start_line(), 3);
assert_eq!(segment.end_line(), 5);

pub const fn start_line(self) -> usize

Returns the first line covered by the segment (inclusive).

pub const fn end_line(self) -> usize

Returns the last line covered by the segment (inclusive).

pub const fn value(self) -> f64

Returns the per-line contribution.

Trait Implementations

impl Clone for LineSegment

fn clone(&self) -> LineSegment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LineSegment

impl Debug for LineSegment

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

Formats the value using the given formatter.

impl PartialEq for LineSegment

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LineSegment