Struct Request 

pub struct Request {
    pub state: Value,
    pub model: Option<String>,
    pub questions: Vec<Question>,
    pub kime: Option<Map<String, Value>>,
}

A validated request.

Fields

state: Value

The state, as sent. Never null.

model: Option<String>

The requested model, if any.

questions: Vec<Question>

The questions in request order.

kime: Option<Map<String, Value>>

The kime extension object, not yet interpreted.

Implementations

impl Request

Building a request in code. Nothing is checked until it is answered, where it goes through the same validation as a request that came in as JSON.

pub fn new(state: impl Into<State>) -> Self

A request about state with no questions yet.

pub fn question(self, q: Question) -> Self

Adds a question, or replaces the one with the same id where it stands, as a repeated key in a JSON object would.

pub fn choice<L: Into<String>, D: Into<String>>( self, id: impl Into<String>, instructions: impl Into<String>, options: impl IntoIterator<Item = (L, D)>, ) -> Self

Adds a choice question, with each option given as a label and its description.

pub fn score<S: Into<String>>( self, id: impl Into<String>, instructions: impl Into<String>, levels: impl IntoIterator<Item = S>, ) -> Self

Adds a score question with its levels, lowest first.

pub fn noul(self, id: impl Into<String>, statement: impl Into<String>) -> Self

Adds a noul question: is statement true of the state.

pub fn to_json(&self) -> Value

The request as the JSON body parse reads.

Trait Implementations

impl Clone for Request

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Request

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

Formats the value using the given formatter.

impl PartialEq for Request

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Request