Struct google_api_proto::google::maps::places::v1::SearchTextRequest

pub struct SearchTextRequest {

    pub text_query: String,
    pub language_code: String,
    pub region_code: String,
    pub rank_preference: i32,
    pub included_type: String,
    pub open_now: bool,
    pub min_rating: f64,
    pub max_result_count: i32,
    pub price_levels: Vec<i32>,
    pub strict_type_filtering: bool,
    pub location_bias: Option<LocationBias>,
    pub location_restriction: Option<LocationRestriction>,
    pub ev_options: Option<EvOptions>,
}

Request proto for SearchText.

Fields

text_query: String

Required. The text query for textual search.

language_code: String

Place details will be displayed with the preferred language if available. If the language code is unspecified or unrecognized, place details of any language may be returned, with a preference for English if such details exist.

Current list of supported languages: https://developers.google.com/maps/faq#languagesupport.

region_code: String

The Unicode country/region code (CLDR) of the location where the request is coming from. This parameter is used to display the place details, like region-specific place name, if available. The parameter can affect results based on applicable law.

For more information, see https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

Note that 3-digit region codes are not currently supported.

rank_preference: i32

How results will be ranked in the response.

included_type: String

The requested place type. Full list of types supported: https://developers.google.com/maps/documentation/places/web-service/place-types. Only support one included type.

open_now: bool

Used to restrict the search to places that are currently open. The default is false.

min_rating: f64

Filter out results whose average user rating is strictly less than this limit. A valid value must be a float between 0 and 5 (inclusively) at a 0.5 cadence i.e. [0, 0.5, 1.0, … , 5.0] inclusively. The input rating will round up to the nearest 0.5(ceiling). For instance, a rating of 0.6 will eliminate all results with a less than 1.0 rating.

max_result_count: i32

Maximum number of results to return. It must be between 1 and 20, inclusively. The default is 20. If the number is unset, it falls back to the upper limit. If the number is set to negative or exceeds the upper limit, an INVALID_ARGUMENT error is returned.

price_levels: Vec<i32>

Used to restrict the search to places that are marked as certain price levels. Users can choose any combinations of price levels. Default to select all price levels.

strict_type_filtering: bool

Used to set strict type filtering for included_type. If set to true, only results of the same type will be returned. Default to false.

location_bias: Option<LocationBias>

The region to search. This location serves as a bias which means results around given location might be returned. Cannot be set along with location_restriction.

location_restriction: Option<LocationRestriction>

The region to search. This location serves as a restriction which means results outside given location will not be returned. Cannot be set along with location_bias.

ev_options: Option<EvOptions>

Optional. Set the searchable EV options of a place search request.

Implementations

impl SearchTextRequest

pub fn rank_preference(&self) -> RankPreference

Returns the enum value of rank_preference, or the default if the field is set to an invalid enum value.

pub fn set_rank_preference(&mut self, value: RankPreference)

Sets rank_preference to the provided enum value.

pub fn price_levels( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<PriceLevel>>

Returns an iterator which yields the valid enum values contained in price_levels.

pub fn push_price_levels(&mut self, value: PriceLevel)

Appends the provided enum value to price_levels.

Trait Implementations

impl Clone for SearchTextRequest

fn clone(&self) -> SearchTextRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchTextRequest

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

Formats the value using the given formatter.

impl Default for SearchTextRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for SearchTextRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for SearchTextRequest

fn eq(&self, other: &SearchTextRequest) -> 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 StructuralPartialEq for SearchTextRequest