Struct PostalAddress

#[non_exhaustive]
pub struct PostalAddress {
    pub revision: i32,
    pub region_code: String,
    pub language_code: String,
    pub postal_code: String,
    pub sorting_code: String,
    pub administrative_area: String,
    pub locality: String,
    pub sublocality: String,
    pub address_lines: Vec<String>,
    pub recipients: Vec<String>,
    pub organization: String,
}

Represents a postal address, e.g. for postal delivery or payments addresses. Given a postal address, a postal service can deliver items to a premise, P.O. Box or similar. It is not intended to model geographical locations (roads, towns, mountains).

In typical usage an address would be created via user input or from importing existing data, depending on the type of process.

Advice on address input / editing:

• Use an i18n-ready address widget such as https://github.com/google/libaddressinput)
• Users should not be presented with UI elements for input or editing of fields outside countries where that field is used.

For more guidance on how to use this schema, please see: https://support.google.com/business/answer/6397478

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.

revision: i32

The schema revision of the PostalAddress. This must be set to 0, which is the latest revision.

All new revisions must be backward compatible with old revisions.

region_code: String

Required. CLDR region code of the country/region of the address. This is never inferred and it is up to the user to ensure the value is correct. See http://cldr.unicode.org/ and http://www.unicode.org/cldr/charts/30/supplemental/territory_information.html for details. Example: “CH” for Switzerland.

language_code: String

Optional. BCP-47 language code of the contents of this address (if known). This is often the UI language of the input form or is expected to match one of the languages used in the address’ country/region, or their transliterated equivalents. This can affect formatting in certain countries, but is not critical to the correctness of the data and will never affect any validation or other non-formatting related operations.

If this value is not known, it should be omitted (rather than specifying a possibly incorrect default).

Examples: “zh-Hant”, “ja”, “ja-Latn”, “en”.

postal_code: String

Optional. Postal code of the address. Not all countries use or require postal codes to be present, but where they are used, they may trigger additional validation with other parts of the address (e.g. state/zip validation in the U.S.A.).

sorting_code: String

Optional. Additional, country-specific, sorting code. This is not used in most regions. Where it is used, the value is either a string like “CEDEX”, optionally followed by a number (e.g. “CEDEX 7”), or just a number alone, representing the “sector code” (Jamaica), “delivery area indicator” (Malawi) or “post office indicator” (e.g. Côte d’Ivoire).

administrative_area: String

Optional. Highest administrative subdivision which is used for postal addresses of a country or region. For example, this can be a state, a province, an oblast, or a prefecture. Specifically, for Spain this is the province and not the autonomous community (e.g. “Barcelona” and not “Catalonia”). Many countries don’t use an administrative area in postal addresses. E.g. in Switzerland this should be left unpopulated.

locality: String

Optional. Generally refers to the city/town portion of the address. Examples: US city, IT comune, UK post town. In regions of the world where localities are not well defined or do not fit into this structure well, leave locality empty and use address_lines.

sublocality: String

Optional. Sublocality of the address. For example, this can be neighborhoods, boroughs, districts.

address_lines: Vec<String>

Unstructured address lines describing the lower levels of an address.

Because values in address_lines do not have type information and may sometimes contain multiple values in a single field (e.g. “Austin, TX”), it is important that the line order is clear. The order of address lines should be “envelope order” for the country/region of the address. In places where this can vary (e.g. Japan), address_language is used to make it explicit (e.g. “ja” for large-to-small ordering and “ja-Latn” or “en” for small-to-large). This way, the most specific line of an address can be selected based on the language.

The minimum permitted structural representation of an address consists of a region_code with all remaining information placed in the address_lines. It would be possible to format such an address very approximately without geocoding, but no semantic reasoning could be made about any of the address components until it was at least partially resolved.

Creating an address only containing a region_code and address_lines, and then geocoding is the recommended way to handle completely unstructured addresses (as opposed to guessing which parts of the address should be localities or administrative areas).

recipients: Vec<String>

Optional. The recipient at the address. This field may, under certain circumstances, contain multiline information. For example, it might contain “care of” information.

organization: String

Optional. The name of the organization at the address.

Implementations

impl PostalAddress

pub fn set_revision<T: Into<i32>>(self, v: T) -> Self

Sets the value of revision.

pub fn set_region_code<T: Into<String>>(self, v: T) -> Self

Sets the value of region_code.

pub fn set_language_code<T: Into<String>>(self, v: T) -> Self

Sets the value of language_code.

pub fn set_postal_code<T: Into<String>>(self, v: T) -> Self

Sets the value of postal_code.

pub fn set_sorting_code<T: Into<String>>(self, v: T) -> Self

Sets the value of sorting_code.

pub fn set_administrative_area<T: Into<String>>(self, v: T) -> Self

Sets the value of administrative_area.

pub fn set_locality<T: Into<String>>(self, v: T) -> Self

Sets the value of locality.

pub fn set_sublocality<T: Into<String>>(self, v: T) -> Self

Sets the value of sublocality.

pub fn set_address_lines<T: Into<Vec<String>>>(self, v: T) -> Self

Sets the value of address_lines.

pub fn set_recipients<T: Into<Vec<String>>>(self, v: T) -> Self

Sets the value of recipients.

pub fn set_organization<T: Into<String>>(self, v: T) -> Self

Sets the value of organization.

Trait Implementations

impl Clone for PostalAddress

fn clone(&self) -> PostalAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PostalAddress

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

Formats the value using the given formatter.

impl Default for PostalAddress

fn default() -> PostalAddress

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PostalAddress

where PostalAddress: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PostalAddress

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PostalAddress