Struct ProximityInfo

pub struct ProximityInfo {
    pub geo_point: Option<GeoPointInfo>,
    pub radius: f64,
    pub radius_units: i32,
    pub address: Option<AddressInfo>,
}

A Proximity criterion. The geo point and radius determine what geographical area is included. The address is a description of the geo point that does not affect ad serving.

There are two ways to create a proximity. First, by setting an address and radius. The geo point will be automatically computed. Second, by setting a geo point and radius. The address is an optional label that won’t be validated.

Fields

geo_point: Option<GeoPointInfo>

Latitude and longitude.

radius: f64

The radius of the proximity.

radius_units: i32

The unit of measurement of the radius. Default is KILOMETERS.

address: Option<AddressInfo>

Full address.

Implementations

impl ProximityInfo

pub fn radius_units(&self) -> ProximityRadiusUnits

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

pub fn set_radius_units(&mut self, value: ProximityRadiusUnits)

Sets radius_units to the provided enum value.

Trait Implementations

impl Clone for ProximityInfo

fn clone(&self) -> ProximityInfo

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ProximityInfo

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

Formats the value using the given formatter.

impl Default for ProximityInfo

fn default() -> Self

Returns the “default value” for a type.

impl Message for ProximityInfo

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

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

where B: Buf, Self: Default,

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

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

where B: Buf, Self: Sized,

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

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

where B: Buf, Self: Sized,

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

impl PartialEq for ProximityInfo

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for ProximityInfo