Struct WebSearchLocation 

pub struct WebSearchLocation { /* private fields */ }

Bounded approximate user location for hosted web search.

Implementations

impl WebSearchLocation

pub const fn new() -> Self

Creates an empty location that can be populated through validated builders.

pub fn with_country( self, country: impl Into<String>, ) -> Result<Self, ModelRequestError>

Sets an ISO 3166-1 alpha-2 uppercase country code.

Errors

Returns an error when the value is not exactly two uppercase ASCII letters.

pub fn with_city( self, city: impl Into<String>, ) -> Result<Self, ModelRequestError>

Sets a bounded city name.

Errors

Returns an error for empty, oversized, or control-containing text.

pub fn with_region( self, region: impl Into<String>, ) -> Result<Self, ModelRequestError>

Sets a bounded region name.

Errors

Returns an error for empty, oversized, or control-containing text.

pub fn with_timezone( self, timezone: impl Into<String>, ) -> Result<Self, ModelRequestError>

Sets a canonical IANA-style timezone name.

Errors

Returns an error for empty, oversized, or non-canonical text.

pub fn country(&self) -> Option<&str>

Returns the optional country code.

pub fn city(&self) -> Option<&str>

Returns the optional city.

pub fn region(&self) -> Option<&str>

Returns the optional region.

pub fn timezone(&self) -> Option<&str>

Returns the optional timezone.

pub const fn is_empty(&self) -> bool

Returns whether no location field is configured.

Trait Implementations

impl Clone for WebSearchLocation

fn clone(&self) -> WebSearchLocation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WebSearchLocation

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

Formats the value using the given formatter.

impl Default for WebSearchLocation

fn default() -> WebSearchLocation

Returns the “default value” for a type.

impl Eq for WebSearchLocation

impl PartialEq for WebSearchLocation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for WebSearchLocation