devela 0.28.0

A development substrate of coherence.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

// devela::sys::os::term::grid::definition
//
//! Defines [`TermGrid`].
//

use crate::{Extent2, PhantomData};

#[doc = crate::_tags!(term data_structure)]
/// A dense row-major grid of terminal-space elements.
#[doc = crate::_doc_meta!{location("sys/os/term/grid")}]
///
/// The grid occupies the first `width × height` elements of its storage.
/// Any remaining storage is retained but lies outside the grid.
///
/// # Methods
///
/// - [Construction and structural access](#construction-and-structural-access)
///   - [new](#method.new).
///   - [extent](#method.extent).
///   - [width](#method.width).
///   - [height](#method.height).
///   - [len](#method.len).
///   - [is_empty](#method.is_empty).
///   - [storage](#method.storage)
///     ([*into*](#method.into_storage), [*slice*](#method.storage_slice)).
///   - [as_slice](#method.as_slice).
///   - [spare_len](#method.spare_len).
///
/// - [Coordinate queries](#coordinate-queries)
///   - [contains](#method.contains).
///   - [index_of](#method.index_of).
///   - [position_of](#method.position_of).
///   - [get](#method.get) ([*xy*](#method.get_xy)).
///   - [row](#method.row).
///
/// - [Mutable access](#mutable-access)
///   - [as_mut_slice](#method.as_mut_slice).
///   - [storage_slice_mut](#method.storage_slice_mut).
///   - [get_mut](#method.get_mut) ([*xy*](#method.get_xy_mut)).
///   - [row_mut](#method.row_mut).
///   - [set](#method.set) ([*xy*](#method.set_xy)).
///
/// - [Text drawing](#text-drawing)
///   - [write_str_at](#method.write_str_at)
///   - [write_str_xy](#method.write_str_xy)
///
/// - [Copy-oriented operations](#copy-oriented-operations)
///   - [fill](#method.fill).
///   - [get_copy](#method.get_copy) ([*xy*](#method.get_xy_copy)).
///
/// - [Region drawing](#region-drawing)
///   - [fill_region](#method.fill_region).
///   - [hline](#method.hline).
///   - [vline](#method.vline).
///   - [frame](#method.frame).
///
/// - [Grid transfer](#grid-transfer)
///   - [blit_at](#method.blit_at).
///   - [blit_region_at](#method.blit_region_at).
//
#[must_use]
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash)]
pub struct TermGrid<E, S> {
    pub(super) storage: S,
    pub(super) extent: Extent2<usize>,
    pub(super) len: usize,
    pub(super) _element: PhantomData<fn() -> E>,
}