lexicon 0.1.0

A convenient interface to get patterns from Conway’s Game of Life’s Lexicon.
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

# Lexicon

[![Rust](https://github.com/scastiel/lexicon-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/scastiel/lexicon-rs/actions/workflows/rust.yml)

A convenient interface to get patterns from the [Lexicon](http://conwaylife.com/ref/lexicon/lex_home.htm) and use them in your implementation of [Conway’s Game of Life](https://en.wikipedia.org/wiki/Conway%27s_Game_of_Life).

## Usage

```rust
let lexicon = lexicon::Lexicon::get();
assert_eq!(lexicon.terms.len() > 0, true);

let glider = lexicon.get_term("glider".to_string()).unwrap();
assert_eq!(glider.width, 3);
assert_eq!(glider.height, 3);
assert_eq!(glider.cells, vec![
  lexicon::Cell { x: 0, y: 0 },
  lexicon::Cell { x: 1, y: 0 },
  lexicon::Cell { x: 2, y: 0 },
  lexicon::Cell { x: 0, y: 1 },
  lexicon::Cell { x: 1, y: 2 }
]);
```

## Regenerate a bin file after an update of the text version

`cargo run` will read the file _res/lexicon.txt_, parse it and serialize the result into _res/lexicon.bin_, which will be used by the library then.