edtui_jagged/
lib.rs

1//! # `edtui_jagged`
2//!
3//! `edtui_jagged` is a Rust library providing a generic container for working with an object,
4//! where each element is organized into lines (rows).
5//!
6//! The central component of this library is the [`Jagged`] struct, which wraps a vector of
7//! vectors. The outer vector represents rows, and the inner vectors represent the elements
8//! within each row.
9//!
10//! ## Generic Parameters
11//!
12//! - `T`: The data type of elements stored within the jagged array.
13//!
14//! ## Examples
15//!
16//! ```rust
17//! use edtui_jagged::Jagged;
18//!
19//! let data = vec![
20//!     vec![1, 2, 3],
21//!     vec![4, 5, 6],
22//!     vec![7, 8, 9],
23//!     vec![0],
24//! ];
25//!
26//! let lines = Jagged::new(data);
27//! ```
28//!
29//! The `Jagged` struct is equipped with various methods for working with the underlying data,
30//! including iterators for efficient traversal and searching.
31//!
32//! ## Features
33//!
34//! - Generic container for working with jagged arrays.
35//! - Convenient creation and manipulation of rows and elements.
36//! - Iteration and searching utilities for enhanced data processing.
37//!
38//! _For more details, refer to the documentation of individual types and methods._
39#![allow(clippy::module_name_repetitions)]
40pub mod index;
41pub mod jagged;
42pub mod traits;
43pub use index::Index2;
44pub use jagged::Jagged;
45pub use traits::JaggedIndex;