Struct Heatmap

pub struct Heatmap {
    pub contribution_weeks: Vec<ContributionWeek>,
}

A Heatmap instance represents a fully scraped and parsed Github constribution heatmap.

A Heatmap is constructed from a reference to a parsed HTML document corresponding to a Github profile.

Fields

contribution_weeks: Vec<ContributionWeek>

A vector of ContributionWeek instances spanning across the entire year of contributions.

Implementations

impl Heatmap

pub fn from_document(document: &Html) -> Result<Self, HeatmapError>

Constructs a new Heatmap instance from a parsed HTML document. Provided reference to HTML document corresponds to the markup of a Github profile page (e.g. https://github.com/torvalds).

ContributionWeek instances will be constructed and pushed to the contribution_weeks vector for as many columns are evident in the parsed markup.

Errors

• HeatmapError::QueryElement fails to query Heatmap SVG element.
• HeatmapError::QueryElement fails to query Heatmap node elements

See ContributionWeek for errors related to constructing ContributionWeek instances.

Panics

A panic will occur in the unlikely event that Selector::parse fails to parse CSS selector constants.

pub fn render(&self, color: &ColorValues)

Generates visual representation of Heatmap data structure, and writes it to standard output.

Resulting Unicode will have a fill color depending on provided ColorValues color variant.

Trait Implementations

impl Debug for Heatmap

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

Formats the value using the given formatter.

impl PartialEq for Heatmap

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

impl StructuralPartialEq for Heatmap