Struct TypedChoice 

#[non_exhaustive]
pub struct TypedChoice<T> {
    pub choice: T,
    pub confidence: f64,
    pub probabilities: Vec<(T, f64)>,
}

A Choice answer with its options parsed into T.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

choice: T

The option with the highest probability.

confidence: f64

How concentrated the distribution is, from 0 to 1.

probabilities: Vec<(T, f64)>

Probability of each option: in declaration order for EnumChoice, in response order for ValueChoice.

Implementations

impl<T> TypedChoice<T>

pub fn new( choice: T, confidence: f64, probabilities: impl IntoIterator<Item = (T, f64)>, ) -> Self

A typed choice, for fixtures and tests.

impl<T: PartialEq> TypedChoice<T>

pub fn probability(&self, option: &T) -> f64

The probability of option; 0 if the response did not include it.

impl<T: Clone> TypedChoice<T>

pub fn ranked(&self) -> Vec<(T, f64)>

Options from most to least probable.

pub fn top(&self, n: usize) -> Vec<(T, f64)>

The n most probable options, most probable first.

Trait Implementations

impl<T: Clone> Clone for TypedChoice<T>

fn clone(&self) -> TypedChoice<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for TypedChoice<T>

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

Formats the value using the given formatter.

impl<'de, T> Deserialize<'de> for TypedChoice<T>

where T: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: PartialEq> PartialEq for TypedChoice<T>

fn eq(&self, other: &TypedChoice<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: ChoiceOptions> ReadAnswer for TypedChoice<T>

fn read(id: &str, answer: &Answer) -> Result<Self, AnswerError>

Fails with AnswerError::UnknownOption when the answer names an option T does not have, which means the response does not belong to this question.

type Output<'a> = TypedChoice<T>

What SystemOneResponse::answer returns for this key.

impl<T> Serialize for TypedChoice<T>

where T: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for TypedChoice<T>