Struct napchart::Napchart

pub struct Napchart {
    pub shape: ChartShape,
    pub color_tags: HashMap<ChartColor, String>,
    // some fields omitted
}

A napchart, as seen on https://napchart.com/

Fields

shape: ChartShape

The default shape of the napchart on napchart.com

color_tags: HashMap<ChartColor, String>

String tags associated with element colors. These are displayed in the inner area of a napchart, along with the accumulated amount of time each color takes up.

Implementations

impl Napchart

pub fn add_lane(&mut self) -> &mut ChartLane

Append a new blank lane to the chart and return a mutable reference to it.

let mut chart = Napchart::default();
let mut lane = chart.add_lane();
assert!(lane.is_empty());
assert_eq!(chart.lanes_len(), 1);

pub fn get_lane(&self, i: usize) -> Option<&ChartLane>

Get a reference to the given lane, or None if out of bounds.

let mut chart = Napchart::default();
chart.add_lane();
assert!(chart.get_lane(0).is_some());
assert!(chart.get_lane(1).is_none());

pub fn get_lane_mut(&mut self, i: usize) -> Option<&mut ChartLane>

Get a mutable reference to the given lane, or None if out of bounds.

let mut chart = Napchart::default();
chart.add_lane();
assert!(chart.get_lane_mut(0).is_some());
assert!(chart.get_lane_mut(1).is_none());

pub fn remove_lane(&mut self, i: usize) -> Option<ChartLane>

Remove the given lane from the chart and return it, or None if out of bounds.

let mut chart = Napchart::default();
chart.add_lane();
let lane = chart.remove_lane(0);
assert!(lane.is_some());
assert_eq!(chart.lanes_len(), 0);

pub fn lanes_len(&self) -> usize

Get the total number of lanes in the chart.

let mut chart = Napchart::default();
assert_eq!(chart.lanes_len(), 0);
chart.add_lane();
assert_eq!(chart.lanes_len(), 1);
chart.add_lane();
assert_eq!(chart.lanes_len(), 2);
chart.remove_lane(1);
chart.remove_lane(0);
assert_eq!(chart.lanes_len(), 0);

pub fn upload(&self) -> UploadBuilder<'_>

Create an UploadBuilder with a reference to this chart.

let client = BlockingClient::default();
let chart = Napchart::default();
let upload: napchart::api::UploadBuilder = chart.upload().title("My Cool Chart");
assert!(client.create_snapshot(upload).is_ok());

impl Napchart

Builder functions to create new napcharts.

let chart = Napchart::default()
                .lanes(3)
                .shape(ChartShape::Wide);
assert_eq!(chart.lanes_len(), 3);
assert_eq!(chart.shape, ChartShape::Wide);

pub fn shape(self, shape: ChartShape) -> Self

Return Napchart with shape set.

let chart = Napchart::default();
assert_eq!(chart.shape, ChartShape::Circle);

let wide_chart = Napchart::default().shape(ChartShape::Wide);
assert_eq!(wide_chart.shape, ChartShape::Wide);

pub fn lanes(self, count: usize) -> Self

Return Napchart with a given number of empty lanes.

let chart = Napchart::default();
assert_eq!(chart.lanes_len(), 0);

let chart2 = Napchart::default().lanes(3);
assert_eq!(chart2.lanes_len(), 3);

Trait Implementations

impl Clone for Napchart

fn clone(&self) -> Napchart

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Napchart

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

Formats the value using the given formatter.

impl Default for Napchart

fn default() -> Napchart

Returns the “default value” for a type.

impl Eq for Napchart

impl PartialEq<Napchart> for Napchart

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Napchart

impl StructuralPartialEq for Napchart