Struct actix_web_location::Location

pub struct Location {
    pub country: Option<String>,
    pub region: Option<String>,
    pub city: Option<String>,
    pub dma: Option<u16>,
    pub provider: String,
}

The location information that providers must produce.

Fields

country: Option<String>

Country in ISO 3166-1 alpha-2 format, such as “MX” for Mexico or “IT” for Italy.

region: Option<String>

Region/region (e.g. a US state) in ISO 3166-2 format, such as “QC” for Quebec (with country = “CA”) or “TX” for Texas (with country = “US”).

city: Option<String>

City, listed by name such as “Portland” or “Berlin”.

dma: Option<u16>

The Designated Market Area code, as defined by Nielsen. Only defined in the US.

provider: String

The name of the provider that produced this recommendation.

Implementations

impl Location

pub fn build() -> LocationBuilder

Create a builder for a Location that can be assembled incrementally.

pub fn country(&self) -> String

Get an owned copy of the country, or the default if the field is None

pub fn region(&self) -> String

Get an owned copy of the region, or the default if the field is None

pub fn city(&self) -> String

Get an owned copy of the city, or the default if the field is None

pub fn dma(&self) -> u16

Get an owned copy of the dma, or the default if the field is None

Trait Implementations

impl Clone for Location

fn clone(&self) -> Location

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Location

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

Formats the value using the given formatter.

impl FromRequest for Location

type Config = LocationConfig

Configuration for this extractor

type Error = Error

The associated error which can be returned.

type Future = LocalBoxFuture<'static, Result<Self, Self::Error>>

Future that resolves to a Self

fn from_request(req: &HttpRequest, _payload: &mut Payload) -> Self::Future

Convert request to a Self

fn extract(req: &HttpRequest) -> Self::Future

Convert request to a Self

fn configure<F>(f: F) -> Self::Config where
    F: FnOnce(Self::Config) -> Self::Config, 

Create and configure config instance.

impl PartialEq<Location> for Location

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

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

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

This method tests for !=.

impl Eq for Location

impl StructuralEq for Location

impl StructuralPartialEq for Location