ca-formats

Crates.ioca-formats
lib.rsca-formats
version0.3.5
sourcesrc
created_at2020-01-26 07:08:53.351322
updated_at2023-03-18 04:20:12.24907
descriptionParsing pattern files for Conway's Game of Life.
homepagehttps://github.com/AlephAlpha/ca-formats
repositoryhttps://github.com/AlephAlpha/ca-formats
max_upload_size
id202076
size71,042
(AlephAlpha)

documentation

README

CA formats parsers

Travis (.com) Crates.io Docs.rs 中文

Parsing pattern files for Conway's Game of Life.

The parsers read a string and return an iterator of coordinates of living cells.

Supported formats

Example

Reading from a string:

use ca_formats::rle::Rle;

const GLIDER: &str = r"#N Glider
#O Richard K. Guy
#C The smallest, most common, and first discovered spaceship. Diagonal, has period 4 and speed c/4.
#C www.conwaylife.com/wiki/index.php?title=Glider
x = 3, y = 3, rule = B3/S23
bob$2bo$3o!";

let glider = Rle::new(GLIDER).unwrap();
assert_eq!(glider.header_data().unwrap().x, 3);
assert_eq!(glider.header_data().unwrap().y, 3);
assert_eq!(glider.header_data().unwrap().rule, Some(String::from("B3/S23")));

let cells = glider.map(|cell| cell.unwrap().position).collect::<Vec<_>>();
assert_eq!(cells, vec![(1, 0), (2, 1), (0, 2), (1, 2), (2, 2)]);

Reading from a file:

use std::fs::File;
use ca_formats::rle::Rle;

let file = File::open("tests/sirrobin.rle").unwrap();
let sirrobin = Rle::new_from_file(file).unwrap();

assert_eq!(sirrobin.count(), 282);

Unknown cells

When the unknown feature is enabled. the Rle type will provide an extra method with_unknown, which turns the RLE into a special variant of RLE format. In this variant there is another symbol, ?, which represents unknown cells. Now unknown cells are the background. Dead cells at the end of each line must not be omitted. The iterator will also explicitly output the dead cells.

This is only supported for RLE.

See also

Commit count: 59

cargo fmt