Struct Contribution

pub struct Contribution {
    pub heat_level: usize,
}

A Contribution instance represents an invidividual heatmap node, with a heat level corresponding to the data-level attribute set on the scraped SVG Rect element.

Contribution instances are typically not constructed explicitly, rather created implicitly by the higher level Heatmap struct via the from_el associated method.

Fields

heat_level: usize

The heat_level property corresponds to the Rect element’s data-level attribute, which Github uses to determine the intensity when shading the Rect element on the front end.

The heat_level property is utilised in the same way when deciding on the intensity of the filled Unicode box character.

Implementations

impl Contribution

pub fn from_el(el: &ElementRef<'_>) -> Result<Self, HeatmapError>

Constructs a new Contribution instance from an HTML element. Provided element reference corresponds to scraped Github heatmap node.

Errors

• HeatmapError::QueryAttribute fails to query heat level attribute
• HeatmapError::ParseAttribute fails to parse heat level attribute

pub fn render(&self, color: &ColorValues) -> String

Renders a contribution node.

Returns a formatted string containing a Unicode box character, with a fill color depending on the provided ColorValues variant, and the heat_level property of the Contribution instance.

Trait Implementations

impl Clone for Contribution

fn clone(&self) -> Contribution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Contribution

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

Formats the value using the given formatter.

impl PartialEq for Contribution

fn eq(&self, other: &Contribution) -> 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 Contribution

impl StructuralPartialEq for Contribution