Struct Rle

pub struct Rle { /* private fields */ }

A representation for RLE file format.

The detail of this format is described in:

• Run Length Encoded - LifeWiki
• Golly Help: File Formats > Extended RLE format

Examples

Parses the given RLE file, and checks live cells included in it:

use std::fs::File;
use life_backend::format::Rle;
use life_backend::Position;
let file = File::open("patterns/rpentomino.rle")?;
let parser = Rle::new(file)?;
assert!(parser.live_cells().eq([Position(1, 0), Position(2, 0), Position(0, 1), Position(1, 1), Position(1, 2)]));

Parses the given string in RLE format:

use life_backend::format::Rle;
use life_backend::Position;
let pattern = "\
    #N R-pentomino\n\
    x = 3, y = 3\n\
    b2o$2o$bo!\n\
";
let parser = pattern.parse::<Rle>()?;
assert!(parser.live_cells().eq([Position(1, 0), Position(2, 0), Position(0, 1), Position(1, 1), Position(1, 2)]));

Implementations

impl Rle

pub fn new<R>(read: R) -> Result<Self>

where R: Read,

Creates from the specified implementor of Read, such as File or &[u8].

Examples

use life_backend::format::Rle;
let pattern = "\
    #N T-tetromino\n\
    x = 3, y = 2\n\
    3o$bo!\n\
";
let parser = Rle::new(pattern.as_bytes())?;

pub const fn width(&self) -> usize

Returns the width written in the pattern.

Examples

use life_backend::format::Rle;
let pattern = "\
    #N T-tetromino\n\
    x = 3, y = 2\n\
    3o$bo!\n\
";
let parser = Rle::new(pattern.as_bytes())?;
assert_eq!(parser.width(), 3);

pub const fn height(&self) -> usize

Returns the height written in the pattern.

Examples

use life_backend::format::Rle;
let pattern = "\
    #N T-tetromino\n\
    x = 3, y = 2\n\
    3o$bo!\n\
";
let parser = Rle::new(pattern.as_bytes())?;
assert_eq!(parser.height(), 2);

pub const fn rule(&self) -> &Rule

Returns the rule.

Examples

use life_backend::format::Rle;
use life_backend::Rule;
let pattern = "\
    #N T-tetromino\n\
    x = 3, y = 2, rule = B3/S23\n\
    3o$bo!\n\
";
let parser = Rle::new(pattern.as_bytes())?;
assert_eq!(parser.rule(), &Rule::conways_life());

pub const fn comments(&self) -> &Vec<String>

Returns comments of the pattern.

Examples

use life_backend::format::Rle;
let pattern = "\
    #N T-tetromino\n\
    x = 3, y = 2\n\
    3o$bo!\n\
";
let parser = Rle::new(pattern.as_bytes())?;
assert_eq!(parser.comments().len(), 1);
assert_eq!(parser.comments()[0], "#N T-tetromino");

pub fn live_cells(&self) -> impl Iterator<Item = Position<usize>> + '_

Creates an owning iterator over the series of live cell positions in ascending order.

Examples

use life_backend::format::Rle;
use life_backend::Position;
let pattern = "\
    #N T-tetromino\n\
    x = 3, y = 2\n\
    3o$bo!\n\
";
let parser = Rle::new(pattern.as_bytes())?;
assert!(parser.live_cells().eq([Position(0, 0), Position(1, 0), Position(2, 0), Position(1, 1)]));

Trait Implementations

impl Clone for Rle

fn clone(&self) -> Rle

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Rle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for Rle

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Format for Rle

fn rule(&self) -> Rule

Returns the rule.

fn live_cells(&self) -> Box<dyn Iterator<Item = Position<usize>> + '_>

Creates an owning iterator over the series of live cell positions in ascending order.

impl FromStr for Rle

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.