Struct sgf_parse::SgfNodeBuilder

pub struct SgfNodeBuilder {
    pub properties: Vec<SgfProp>,
    pub children: Vec<SgfNodeBuilder>,
    pub is_root: bool,
}

A builder for SgfNodes.

SgfNodes are immutable and required to be valid from the time of creation. An SgfNodeBuilder can be used to construct a complicated game tree which can then be converted to an SgfNode with little overhead. If you're building an SGF file from scratch, this should be your starting point. If you want to modify an existing SGF, SgfNode::into_builder will get you an SgfNodeBuilder to work with.

Note that SgfNodeBuilder performs no validation until you call the build method. The user is responsible for ensuring that no invalid combination of properties has been set.

Examples

use sgf_parse::{serialize, SgfNodeBuilder, SgfProp};

let mut node = SgfNodeBuilder::new();
node.properties.push(SgfProp::new("B".to_string(), vec!["jj".to_string()]).unwrap());
let mut child = SgfNodeBuilder::new();
child.properties.push(SgfProp::new("W".to_string(), vec!["cd".to_string()]).unwrap());
node.children.push(child);

let node = node.build();
let sgf = serialize(&node);

assert_eq!(sgf, "(;B[jj];W[cd])");

Fields

properties: Vec<SgfProp>

children: Vec<SgfNodeBuilder>

is_root: bool

Implementations

impl SgfNodeBuilder

pub fn new() -> Self

Return a new empty SgfNodeBuilder.

pub fn build(self) -> Result<SgfNode, SgfParseError>

Consume the SgfNodeBuilder and its children and return an SgfNode.

Errors

If the SgfNode or any of its children are invalid, then an error is returned.

Trait Implementations

impl Clone for SgfNodeBuilder

fn clone(&self) -> SgfNodeBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SgfNodeBuilder

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

Formats the value using the given formatter.

impl Default for SgfNodeBuilder

fn default() -> SgfNodeBuilder

Returns the "default value" for a type.

impl PartialEq<SgfNodeBuilder> for SgfNodeBuilder

fn eq(&self, other: &SgfNodeBuilder) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &SgfNodeBuilder) -> bool

This method tests for !=.

impl StructuralPartialEq for SgfNodeBuilder