Struct address_formatter::Formatter

pub struct Formatter { /* fields omitted */ }

This Formatter holds all the configuration needed to format a Place to a nice text.

The main method is the format method, that takes a Place or something that can be converted to a Place and return a result with the formatted String

   use address_formatter::Component::*;
   let formatter = address_formatter::Formatter::default();

   let addr: address_formatter::Place = hashmap!(
       City => "Toulouse",
       Country => "France",
       CountryCode => "FR",
       County => "Toulouse",
       HouseNumber => "17",
       Neighbourhood => "Lafourguette",
       Postcode => "31000",
       Road => "Rue du Médecin-Colonel Calbairac",
       State => "Midi-Pyrénées",
       Suburb => "Toulouse Ouest",
   ).into();

   assert_eq!(
       formatter.format(addr).unwrap(),
       r#"17 Rue du Médecin-Colonel Calbairac
31000 Toulouse
France
"#
       .to_owned()
   )

Methods

impl Formatter

pub fn format(&self, into_addr: impl Into<Place>) -> Result<String, Error>

make a human readable text from a Place

   use address_formatter::Component::*;
   let formatter = address_formatter::Formatter::default();

   let addr: address_formatter::Place = hashmap!(
       City => "Toulouse",
       Country => "France",
       CountryCode => "FR",
       County => "Toulouse",
       HouseNumber => "17",
       Neighbourhood => "Lafourguette",
       Postcode => "31000",
       Road => "Rue du Médecin-Colonel Calbairac",
       State => "Midi-Pyrénées",
       Suburb => "Toulouse Ouest",
   ).into();

   assert_eq!(
       formatter.format(addr).unwrap(),
       r#"17 Rue du Médecin-Colonel Calbairac
31000 Toulouse
France
"#
       .to_owned()
   )

pub fn format_with_config(
    &self,
    into_addr: impl Into<Place>,
    conf: Configuration
) -> Result<String, Error>

make a human readable text from a Place Same as the format method, but with a Configuration object

pub fn short_addr_format(
    &self,
    into_addr: impl Into<Place>
) -> Result<String, Error>

make a human readable short text on 1 line with only the address Place There is basically only the housenumber and the road

   use address_formatter::Component::*;
   let formatter = address_formatter::Formatter::default();

   let addr: address_formatter::Place = hashmap!(
       City => "Toulouse",
       Country => "France",
       CountryCode => "FR",
       County => "Toulouse",
       HouseNumber => "17",
       Neighbourhood => "Lafourguette",
       Postcode => "31000",
       Road => "Rue du Médecin-Colonel Calbairac",
       State => "Midi-Pyrénées",
       Suburb => "Toulouse Ouest",
   ).into();

   assert_eq!(
       formatter.short_addr_format(addr).unwrap(),
       r#"17 Rue du Médecin-Colonel Calbairac"#
       .to_owned()
   )

pub fn short_addr_format_with_config(
    &self,
    into_addr: impl Into<Place>,
    conf: Configuration
) -> Result<String, Error>

make a human readable short text on 1 line with only the address Place Same as the short_addr_format method, but with a Configuration object

Trait Implementations

impl Default for Formatter

fn default() -> Self

Default constructor