Struct fiberplane_models::providers::AutoSuggestRequest

#[non_exhaustive]
pub struct AutoSuggestRequest {
    pub query: String,
    pub query_type: String,
    pub field: String,
    pub other_field_data: Option<String>,
}

A request for a provider to provide auto-suggestions.

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.

query: String

The value of the field being typed by the user, up to the focus offset.

query_type: String

The query type of the provider we’re requesting suggestions for.

field: String

The field in the query form we’re requesting suggestions for.

other_field_data: Option<String>

Some other fields of the cell data. The choice of which other fields are sent in the request is left to the caller. The encoding of the other fields is left to the implementation in Studio, and follows the format of cells Query Data.

Implementations

impl AutoSuggestRequest

pub fn builder() -> AutoSuggestRequestBuilder<((), (), (), ())>

Create a builder for building AutoSuggestRequest. On the builder, call .query(...), .query_type(...), .field(...), .other_field_data(...) to set the values of the fields. Finally, call .build() to create the instance of AutoSuggestRequest.

impl AutoSuggestRequest

pub fn parse(query_data: Blob) -> Result<Self, Error>

pub fn schema() -> QuerySchema

Trait Implementations

impl Clone for AutoSuggestRequest

fn clone(&self) -> AutoSuggestRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AutoSuggestRequest

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

Formats the value using the given formatter.

impl Default for AutoSuggestRequest

fn default() -> AutoSuggestRequest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AutoSuggestRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AutoSuggestRequest

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for AutoSuggestRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for AutoSuggestRequest

impl StructuralPartialEq for AutoSuggestRequest