Struct Akinator

pub struct Akinator {
    pub language: Language,
    pub theme: Theme,
    pub child_mode: bool,
    pub current_question: Option<String>,
    pub progression: f32,
    pub step: usize,
    pub first_guess: Option<Guess>,
    pub guesses: Vec<Guess>,
    /* private fields */
}

Represents an akinator game

Fields

language: Language

The language for the akinator session

theme: Theme

The theme for the akinator session

One of ‘Characters’, ‘Animals’, or ‘Objects’

child_mode: bool

indicates whether or not to filter out NSFW questions and content

current_question: Option<String>

returns the current question to answer

progression: f32

returns the progress of the akinator a float out of 100.0

step: usize

returns the a counter of questions asked and answered starts at 0

first_guess: Option<Guess>

returns the akinator’s best guess

Only will be set when Self::win has been called

guesses: Vec<Guess>

a vec containing all the possible guesses by the akinator

Only will be set when Self::win has been called

Implementations

impl Akinator

pub fn new() -> Result<Self>

Creates a new Akinator instance with fields filled with default values

Errors

If failed to create HTTP reqwest client

pub const fn with_theme(self, theme: Theme) -> Self

builder method to set the [Self.theme] for the akinator game

pub const fn with_language(self, language: Language) -> Self

builder method to set the [Self.language] for the akinator game

pub const fn with_child_mode(self) -> Self

builder function to turn on [Self.child_mode]

pub async fn start(&mut self) -> Result<Option<String>>

Starts the akinator game and returns the first question

Errors

see errors docs for more info

pub async fn answer(&mut self, answer: Answer) -> Result<Option<String>>

answers the akinator’s current question which can be retrieved with [Self.current_question]

Errors

see errors docs for more info

pub async fn win(&mut self) -> Result<Option<Guess>>

tells the akinator to end the game and make it’s guess and returns its best guess, which also can be retrieved with [Self.first_guess]

Errors

see errors docs for more info

pub async fn back(&mut self) -> Result<Option<String>>

Goes back 1 question and returns the current question Returns an Err value with Error::CantGoBackAnyFurther if we are already on question 0

Errors

see errors docs for more info

Trait Implementations

impl Clone for Akinator

fn clone(&self) -> Akinator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Akinator

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

Formats the value using the given formatter.