grid_engine/lib.rs
1// Copyright (c) 2025 Thiago Ramos
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! Grid Engine is a flexible and efficient library for managing 2D grid-based layouts.
22//!
23//! This crate provides functionality for:
24//! - Managing items in a 2D grid with automatic collision handling
25//! - Dynamic vertical expansion of the grid
26//! - Event system for tracking grid changes
27//! - Strong type safety and error handling
28//!
29//! # Example
30//!
31//! ```rust
32//! use grid_engine::grid_engine::GridEngine;
33//! # use std::error::Error;
34//!
35//! # fn main() -> Result<(), Box<dyn Error>> {
36//! // Create a new 10x12 grid
37//! let mut grid = GridEngine::new(10, 12);
38//!
39//! // Add items (automatic collision handling)
40//! grid.add_item("box1".to_string(), 0, 0, 2, 2)?;
41//!
42//! // Move items
43//! grid.move_item("box1", 2, 2)?;
44//!
45//! # Ok(())
46//! # }
47//! ```
48//!
49//! See the `examples` directory for more usage examples.
50
51mod error;
52pub mod grid_engine;
53mod grid_events;
54mod inner_grid;
55pub mod node;
56mod utils;