Struct houndify::Disambiguation

pub struct Disambiguation {
    pub num_to_show: i64,
    pub choice_data: DisambiguationChoice,
}

Fields

num_to_show: i64

This field tells the client how many of the results from "AllResults" should be shown to the user, for the user to choose among. If it is 1, then the server is suggesting not giving the user a choice and instead just showing the first result in "AllResults". If it is greater than one, the server is suggesting showing that many results and asking the user to choose among them. The elements of "AllResults" are ordered in preference from most prefered to least, so if this field has the value 3, the server is suggesting using the first three results from "AllResults".

choice_data: DisambiguationChoice

This is an array with the number of elements specified by "NumToShow". For each element, it gives information for the corresponding element of "AllResults". This is information about that result that can be used to inform the disambiguous decision about which result to use.

Trait Implementations

impl Debug for Disambiguation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Disambiguation

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for Disambiguation

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

Serialize this value into the given Serde serializer.