Struct Plaintext

pub struct Plaintext { /* private fields */ }

A representation for Plaintext file format.

The detail of this format is described in:

• Plaintext - LifeWiki

Examples

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

use std::fs::File;
use life_backend::format::Plaintext;
use life_backend::Position;
let file = File::open("patterns/rpentomino.cells")?;
let parser = Plaintext::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 Plaintext format:

use life_backend::format::Plaintext;
use life_backend::Position;
let pattern = "\
    !Name: R-pentomino\n\
    .OO\n\
    OO.\n\
    .O.\n\
";
let parser = pattern.parse::<Plaintext>()?;
assert!(parser.live_cells().eq([Position(1, 0), Position(2, 0), Position(0, 1), Position(1, 1), Position(1, 2)]));

Implementations

impl Plaintext

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::Plaintext;
let pattern = "\
    !Name: T-tetromino\n\
    OOO\n\
    .O.\n\
";
let parser = Plaintext::new(pattern.as_bytes())?;

pub fn name(&self) -> Option<String>

Returns the name of the pattern.

Examples

use life_backend::format::Plaintext;
let pattern = "\
    !Name: T-tetromino\n\
    OOO\n\
    .O.\n\
";
let parser = Plaintext::new(pattern.as_bytes())?;
assert_eq!(parser.name(), Some("T-tetromino".to_string()));

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

Returns comments of the pattern.

Examples

use life_backend::format::Plaintext;
let pattern = "\
    !Name: T-tetromino\n\
    !comment0\n\
    !comment1\n\
    OOO\n\
    .O.\n\
";
let parser = Plaintext::new(pattern.as_bytes())?;
assert_eq!(parser.comments().len(), 2);
assert_eq!(parser.comments()[0], "comment0");
assert_eq!(parser.comments()[1], "comment1");

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::Plaintext;
use life_backend::Position;
let pattern = "\
    !Name: T-tetromino\n\
    OOO\n\
    .O.\n\
";
let parser = Plaintext::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 Plaintext

fn clone(&self) -> Plaintext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Plaintext

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

Formats the value using the given formatter.

impl Display for Plaintext

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

Formats the value using the given formatter.

impl Format for Plaintext

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 Plaintext

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.