Struct PlaintextBuilder

pub struct PlaintextBuilder<Name = PlaintextBuilderNoName, Comment = PlaintextBuilderNoComment>
where
    Name: PlaintextBuilderName,
    Comment: PlaintextBuilderComment,
{ /* private fields */ }

A builder of Plaintext.

Examples

Creates a builder via collect() with live cell positions, set a name via name(), then builds Plaintext via build():

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(2, 0), Position(0, 1), Position(1, 1), Position(1, 2)];
let target = pattern.iter().collect::<PlaintextBuilder>().name("R-pentomino").build()?;
let expected = "\
    !Name: R-pentomino\n\
    .OO\n\
    OO.\n\
    .O.\n\
";
assert_eq!(format!("{target}"), expected);

Creates an empty builder via new(), set a name via name(), injects live cell positions via extend(), then builds Plaintext via build():

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(2, 0), Position(0, 1), Position(1, 1), Position(1, 2)];
let mut builder = PlaintextBuilder::new().name("R-pentomino");
builder.extend(pattern.iter());
let target = builder.build()?;
let expected = "\
    !Name: R-pentomino\n\
    .OO\n\
    OO.\n\
    .O.\n\
";
assert_eq!(format!("{target}"), expected);

Implementations

impl PlaintextBuilder<PlaintextBuilderNoName, PlaintextBuilderNoComment>

pub fn new() -> Self

Creates a builder that contains no live cells.

Examples

use life_backend::format::PlaintextBuilder;
let builder = PlaintextBuilder::new();

impl<Name, Comment> PlaintextBuilder<Name, Comment>

where Name: PlaintextBuilderName, Comment: PlaintextBuilderComment,

pub fn build(self) -> Result<Plaintext>

Builds the Plaintext value.

Examples

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let builder: PlaintextBuilder = pattern.iter().collect();
let target = builder.build()?;

impl<Comment> PlaintextBuilder<PlaintextBuilderNoName, Comment>

where Comment: PlaintextBuilderComment,

pub fn name( self, str: &str, ) -> PlaintextBuilder<PlaintextBuilderWithName, Comment>

Set the name.

Examples

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let target = pattern
    .iter()
    .collect::<PlaintextBuilder>()
    .name("foo")
    .build()?;
assert_eq!(target.name(), Some("foo".to_string()));

Errors

Code that calls name() twice or more will fail at compile time. For example:

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let target = pattern
    .iter()
    .collect::<PlaintextBuilder>()
    .name("foo")
    .name("bar") // Compile error
    .build()?;

build() returns an error if the string passed by name() includes multiple lines. For example:

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let target = pattern
    .iter()
    .collect::<PlaintextBuilder>()
    .name("foo\nbar")
    .build()?; // Should fail

impl<Name> PlaintextBuilder<Name, PlaintextBuilderNoComment>

where Name: PlaintextBuilderName,

pub fn comment( self, str: &str, ) -> PlaintextBuilder<Name, PlaintextBuilderWithComment>

Set the comment. If the argument includes newlines, the instance of Plaintext built by build() includes multiple comment lines.

Examples

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let target = pattern
    .iter()
    .collect::<PlaintextBuilder>()
    .comment("comment0\ncomment1")
    .build()?;
assert_eq!(target.comments().len(), 2);
assert_eq!(target.comments()[0], "comment0");
assert_eq!(target.comments()[1], "comment1");

Errors

Code that calls comment() twice or more will fail at compile time. For example:

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let target = pattern
    .iter()
    .collect::<PlaintextBuilder>()
    .comment("comment0")
    .comment("comment1") // Compile error
    .build()?;

Trait Implementations

impl<Name, Comment> Clone for PlaintextBuilder<Name, Comment>

where Name: PlaintextBuilderName + Clone, Comment: PlaintextBuilderComment + Clone,

fn clone(&self) -> PlaintextBuilder<Name, Comment>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Name, Comment> Debug for PlaintextBuilder<Name, Comment>

where Name: PlaintextBuilderName + Debug, Comment: PlaintextBuilderComment + Debug,

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

Formats the value using the given formatter.

impl Default for PlaintextBuilder<PlaintextBuilderNoName, PlaintextBuilderNoComment>

fn default() -> Self

Returns the default value of the type, same as the return value of new().

impl<'a, Name, Comment> Extend<&'a Position<usize>> for PlaintextBuilder<Name, Comment>

where Name: PlaintextBuilderName, Comment: PlaintextBuilderComment,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = &'a Position<usize>>,

Extends the builder with the contents of the specified non-owning iterator over the series of &Position<usize>. Each item in the series represents an immutable reference of a live cell position.

Examples

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let iter = pattern.iter();
let mut builder = PlaintextBuilder::new();
builder.extend(iter);

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<Name, Comment> Extend<Position<usize>> for PlaintextBuilder<Name, Comment>

where Name: PlaintextBuilderName, Comment: PlaintextBuilderComment,

fn extend<T>(&mut self, iter: T)

where T: IntoIterator<Item = Position<usize>>,

Extends the builder with the contents of the specified owning iterator over the series of Position<usize>. Each item in the series represents a moved live cell position.

Examples

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let iter = pattern.into_iter();
let mut builder = PlaintextBuilder::new();
builder.extend(iter);

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl<'a> FromIterator<&'a Position<usize>> for PlaintextBuilder<PlaintextBuilderNoName, PlaintextBuilderNoComment>

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = &'a Position<usize>>,

Creates a value from a non-owning iterator over a series of &Position<usize>. Each item in the series represents an immutable reference of a live cell position.

Examples

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let iter = pattern.iter();
let builder: PlaintextBuilder = iter.collect();

impl FromIterator<Position<usize>> for PlaintextBuilder<PlaintextBuilderNoName, PlaintextBuilderNoComment>

fn from_iter<T>(iter: T) -> Self

where T: IntoIterator<Item = Position<usize>>,

Creates a value from an owning iterator over a series of Position<usize>. Each item in the series represents a moved live cell position.

Examples

use life_backend::format::PlaintextBuilder;
use life_backend::Position;
let pattern = [Position(1, 0), Position(0, 1)];
let iter = pattern.into_iter();
let builder: PlaintextBuilder = iter.collect();