conway_gol_rs/lib.rs
1//! Conway's Game of Life — small Rust library
2//!
3//! This crate provides a simple, in-memory implementation of Conway's Game of
4//! Life. The grid uses toroidal wrapping for neighbour calculations (edges
5//! wrap around). The main types exported are:
6//!
7//! - `ConwayGameGrid` — the main grid type. Create with `ConwayGameGrid::new(width, height)`.
8//! - `Cell` and `UpdatedCell` — primitives used to represent cell state and batched updates.
9//!
10//! Example:
11//!
12//! ```rust
13//! use conway_gol_rs::{ConwayGameGrid, UpdatedCell};
14//!
15//! let mut g = ConwayGameGrid::new(10, 10);
16//! g.set(5, 5, true);
17//! g.iterate();
18//! g.dump();
19//! ```
20mod cell;
21mod grid;
22
23pub use cell::{Cell, UpdatedCell};
24pub use grid::ConwayGameGrid;