Struct klondike_lib::model::area_list::AreaList

pub struct AreaList { /* fields omitted */ }

A list of areas with one selected and the rest unselected that can efficiently move the selection and map area ids to areas.

Our implementation uses a zipper data structure. The selected_area is the zipper head, and the before_areas and after_areas lists function as stacks; we pop areas back and forth to move the selection back and forth.

Implementations

impl AreaList

pub fn new<T, I>(areas: T) -> Result<AreaList> where
    T: IntoIterator<Item = Box<dyn UnselectedArea>, IntoIter = I>,
    I: Iterator<Item = Box<dyn UnselectedArea>>, 

pub fn len(&self) -> usize

pub fn get_by_index(&self, index: usize) -> Result<&dyn Area>

pub fn get_by_index_mut(&mut self, index: usize) -> Result<&mut dyn Area>

pub fn get_by_area_id(&self, area_id: AreaId) -> Result<&dyn Area>

pub fn get_by_area_id_mut(&mut self, area_id: AreaId) -> Result<&mut dyn Area>

pub fn selected(&self) -> &dyn SelectedArea

pub fn selected_mut(&mut self) -> &mut dyn SelectedArea

pub fn area_ids(&self) -> Vec<AreaId>

pub fn iter<'b>(&'b self) -> impl Iterator<Item = &'b dyn Area> + 'b

pub fn iter_left_from_selection<'b>(
    &'b self
) -> impl Iterator<Item = &'b dyn Area> + 'b

pub fn iter_right_from_selection<'b>(
    &'b self
) -> impl Iterator<Item = &'b dyn Area> + 'b

pub fn move_selection(&mut self, target_area_id: AreaId) -> Result<Vec<AreaId>>

pub fn activate_selected(&mut self) -> Result<Vec<AreaId>>

pub fn return_held(&mut self) -> Result<Vec<AreaId>>

pub fn select_more(&mut self) -> Result<Vec<AreaId>>

pub fn select_less(&mut self) -> Result<Vec<AreaId>>

Trait Implementations

impl Debug for AreaList

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

Formats the value using the given formatter.