Enum gtp::Response

pub enum Response {
    Error((Option<u32>, String)),
    Result((Option<u32>, String)),
}

Represents a GTP response from the GTP engine.

Variants

Error((Option<u32>, String))Result((Option<u32>, String))

Methods

impl Response

pub fn text(&self) -> String

Returns the complete response text, which you may feed into EntityParser.

See also the Response::entities method.

pub fn id_0(&self) -> u32

Returns the ID of the response. Returns 0 if no ID was submitted.

pub fn entities<T>(
    &self,
    parse_fn: T
) -> Result<Vec<Entity>, ResponseParseError> where
    T: Fn(&mut EntityParser) -> &mut EntityParser, 

Parses entities from a Response

let mut rp = gtp::ResponseParser::new();
rp.feed("= 10 w H6\n\n");
let entity_vec =
    rp.get_response().unwrap()
      .entities(|ep| ep.i().mv())
      .unwrap();
assert_eq!(format!("{:?}", entity_vec),
           "[Int(10), Move((W, (8, 6)))]");

if let gtp::Entity::Int(i) = entity_vec[0] {
    assert_eq!(i, 10);
}

Here is an example for how to read a variable length list:

let mut rp = gtp::ResponseParser::new();
rp.feed("= A\nB\nC\nD\nE\n\n");
let entity_vec =
    rp.get_response().unwrap()
      .entities(|ep| { while !ep.is_eof() { ep.s(); }; ep })
      .unwrap();
assert_eq!(format!("{:?}", entity_vec),
           "[String(\"A\"), String(\"B\"), String(\"C\"), String(\"D\"), String(\"E\")]");

Trait Implementations

impl PartialEq<Response> for Response

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

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

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

This method tests for !=.

impl Clone for Response

fn clone(&self) -> Response

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Response

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

Formats the value using the given formatter.