Struct napchart::ChartLane

pub struct ChartLane {
    pub locked: bool,
    // some fields omitted
}

A single lane of a napchart

Fields

locked: bool

Whether the lane is locked on napchart.com. Has no effect in rust.

Implementations

impl ChartLane

pub fn clear(&mut self)

Clear all elements from the lane.

let mut chart = Napchart::default();
let mut lane = chart.add_lane();
lane.add_element(0, 60).unwrap();
lane.add_element(60, 120).unwrap();
lane.add_element(120, 180).unwrap();
assert!(!lane.is_empty());
lane.clear();
assert!(lane.is_empty());

pub fn is_empty(&self) -> bool

True if the lane has no elements.

let mut chart = Napchart::default();
let mut lane = chart.add_lane();
assert!(lane.is_empty());
lane.add_element(0, 60).unwrap();
assert!(!lane.is_empty());

pub fn elems_len(&self) -> usize

The number of elements in the lane.

let mut chart = Napchart::default();
let mut lane = chart.add_lane();
assert_eq!(lane.elems_len(), 0);
lane.add_element(0, 60).unwrap();
lane.add_element(60, 120).unwrap();
lane.add_element(120, 180).unwrap();
assert_eq!(lane.elems_len(), 3);

pub fn add_element(
    &mut self,
    start: u16,
    end: u16
) -> Result<&mut ChartElement, ErrorKind>

Add a new element to the lane. Start and end must both be between [0 and 1440). Error if the new element would overlap with the existing elements.

let mut chart = Napchart::default();
let mut lane = chart.add_lane();
assert!(lane.add_element(0, 30).is_ok());
assert!(lane.add_element(15, 45).is_err());
assert!(lane.add_element(30, 60).is_ok());
assert_eq!(lane.elems_len(), 2);

pub fn elems_iter(&self) -> Iter<'_, ChartElement>

Get an iterator over the elements in the lane.

let mut chart = Napchart::default();
let mut lane = chart.add_lane();
lane.add_element(0, 60).unwrap();
lane.add_element(60, 120).unwrap();
lane.add_element(120, 180).unwrap();
let mut iter = lane.elems_iter();
assert_eq!(iter.next().unwrap().get_position(), (0, 60));
assert_eq!(iter.next().unwrap().get_position(), (60, 120));
assert_eq!(iter.next().unwrap().get_position(), (120, 180));

Trait Implementations

impl Clone for ChartLane

fn clone(&self) -> ChartLane

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ChartLane

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

Formats the value using the given formatter.

impl Default for ChartLane

fn default() -> ChartLane

Returns the “default value” for a type.

impl PartialEq<ChartLane> for ChartLane

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

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

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

This method tests for !=.

impl Eq for ChartLane

impl StructuralEq for ChartLane

impl StructuralPartialEq for ChartLane