Enum sgf_parse::SgfProp

pub enum SgfProp {
    B(Move),
    KO,
    MN(i64),
    W(Move),
    AB(Vec<Point>),
    AE(Vec<Point>),
    AW(Vec<Point>),
    PL(Color),
    C(String),
    DM(Double),
    GB(Double),
    GW(Double),
    HO(Double),
    N(String),
    UC(Double),
    V(f64),
    BM(Double),
    DO,
    IT,
    TE(Double),
    AR(Vec<(Point, Point)>),
    CR(Vec<Point>),
    DD(Vec<Point>),
    LB(Vec<(Point, String)>),
    LN(Vec<(Point, Point)>),
    MA(Vec<Point>),
    SL(Vec<Point>),
    SQ(Vec<Point>),
    TR(Vec<Point>),
    AP((String, String)),
    CA(String),
    FF(i64),
    GM(i64),
    ST(i64),
    SZ((u8, u8)),
    HA(i64),
    KM(f64),
    AN(String),
    BR(String),
    BT(String),
    CP(String),
    DT(String),
    EV(String),
    GN(String),
    GC(String),
    ON(String),
    OT(String),
    PB(String),
    PC(String),
    PW(String),
    RE(String),
    RO(String),
    RU(String),
    SO(String),
    TM(f64),
    US(String),
    WR(String),
    WT(String),
    BL(f64),
    OB(i64),
    OW(i64),
    WL(f64),
    FG(Option<(i64, String)>),
    PM(i64),
    VW(Vec<Point>),
    TB(Vec<Point>),
    TW(Vec<Point>),
    Unknown(String, Vec<String>),
}

An SGF Property with identifier and value.

All general properties from the SGF specification and all go specific properties will return the approprite enum instance with parsed data. Unrecognized properties, or properties from other games will return Unknown(identifier, values).

See Property Value Types for a list of types recognized by SGF. For parsing purposes the following mappings are used:

• 'Number' => i64
• 'Real' => f64
• 'Double' => Double
• 'Color' => Color
• 'SimpleText' => String (formatted and escaped as here)
• 'Text' => String (formatted and escaped as here)
• 'Point' => Point
• 'Stone' => Point
• 'Move' => Move
• 'List' => Vec
• 'Compose' => a tuple of the composed values

Variants

B(Move)

KO

MN(i64)

W(Move)

AB(Vec<Point>)

AE(Vec<Point>)

AW(Vec<Point>)

PL(Color)

C(String)

DM(Double)

GB(Double)

GW(Double)

HO(Double)

N(String)

UC(Double)

V(f64)

BM(Double)

DO

IT

TE(Double)

AR(Vec<(Point, Point)>)

CR(Vec<Point>)

DD(Vec<Point>)

LB(Vec<(Point, String)>)

LN(Vec<(Point, Point)>)

MA(Vec<Point>)

SL(Vec<Point>)

SQ(Vec<Point>)

TR(Vec<Point>)

AP((String, String))

CA(String)

FF(i64)

GM(i64)

ST(i64)

SZ((u8, u8))

HA(i64)

KM(f64)

AN(String)

BR(String)

BT(String)

CP(String)

DT(String)

EV(String)

GN(String)

GC(String)

ON(String)

OT(String)

PB(String)

PC(String)

PW(String)

RE(String)

RO(String)

RU(String)

SO(String)

TM(f64)

US(String)

WR(String)

WT(String)

BL(f64)

OB(i64)

OW(i64)

WL(f64)

FG(Option<(i64, String)>)

PM(i64)

VW(Vec<Point>)

TB(Vec<Point>)

TW(Vec<Point>)

Unknown(String, Vec<String>)

Implementations

impl SgfProp

pub fn new(
    identifier: String,
    values: Vec<String>
) -> Result<SgfProp, SgfParseError>

Returns a new property parsed from the provided identifier and values

Examples

use sgf_parse::SgfProp;

// SgfProp::B(Point{ x: 2, y: 3 }
let prop = SgfProp::new("B".to_string(), vec!["cd".to_string()]);
// SgfProp::AB(vec![Point{ x: 2, y: 3 }, Point { x: 3, y: 3 }])
let prop = SgfProp::new("AB".to_string(), vec!["cd".to_string(), "dd".to_string()]);
// SgfProp::Unknown("FOO", vec!["Text"])
let prop = SgfProp::new("FOO".to_string(), vec!["Text".to_string()]);

pub fn identifier(&self) -> String

Returns a the identifier associated with the SgfProp.

Examples

use sgf_parse::SgfProp;

// Prints "W"
let prop = SgfProp::new("W".to_string(), vec!["de".to_string()]).unwrap();
println!("Identifier: {}", prop.identifier());
// Prints "FOO"
let prop = SgfProp::new("FOO".to_string(), vec!["de".to_string()]).unwrap();
println!("Identifier: {}", prop.identifier());

pub fn property_type(&self) -> Option<PropertyType>

Returns the PropertyType associated with the property.

Examples

use sgf_parse::SgfProp;

// Prints "W"
let prop = SgfProp::new("W".to_string(), vec!["de".to_string()]).unwrap();
println!("Identifier: {}", prop.identifier());
// Prints "FOO"
let prop = SgfProp::new("FOO".to_string(), vec!["de".to_string()]).unwrap();
println!("Identifier: {}", prop.identifier());

Trait Implementations

impl Clone for SgfProp

fn clone(&self) -> SgfProp

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SgfProp

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

Formats the value using the given formatter.