Struct Parse

pub struct Parse;

The Parser struct holds methods for parsing addresses.

Implementations

impl Parse

pub fn address_number(input: &str) -> IResult<&str, Option<i64>>

The address_number function expects one or more numeric digits, returned as an i64 value. TODO: 2501-2503 address range should read as 2501 and discard remainder of range.

pub fn address_number_suffix(input: &str) -> IResult<&str, Option<&str>>

The parse_address_number_suffix function peeks at the next value in the input, checking if the second character in the string is non-alphanumeric. Since address number suffixes in Grants Pass take values of either 1/2 or 3/4, the second character will be /, which is not a valid character for any components of the street name. So if a / is present, it must be an address number suffix, and this function will parse and return it. If no address number suffix is present, the function returns None.

Note this approach is not valid for address number suffixes that do not conform to the indicated pattern.

pub fn pre_directional( input: &str, ) -> IResult<&str, Option<StreetNamePreDirectional>>

The parse_pre_directional function attempts to parse the next word in the input to a StreetNamePreDirectional. If a StreetNamePreDirectional is present, the function returns the value and the remainder of the input. If not present, the function returns None as the directional and gives the full input back.

pub fn pre_modifier(input: &str) -> IResult<&str, Option<StreetNamePreModifier>>

The pre_modifier method attempts to parse the next word in the input as a StreetNamePreModifier variant. Returns the full input in no pre-modifier is present.

pub fn pre_type(input: &str) -> IResult<&str, Option<StreetNamePreType>>

The pre_type method attempts to parse the next word in the input as a StreetNamePreType variant. Returns the full input if no pre-type is present.

pub fn separator(input: &str) -> IResult<&str, Option<StreetSeparator>>

The separator method attempts to parse the next word in the input as a StreetSeparator variant. Returns the full input if no separator is present.

pub fn street_name(input: &str) -> IResult<&str, Option<String>>

The street_name method attempts to parse the next sequence of words in the input as a street name. After finding at least one word, will return if the next word in input is a street name post type. Screen for PO Boxes? TODO: If no street name is present, but street type is present, this will categorize the street type as a street name, because we do not check for post-type on the first pass. Eg. West Street parses as directional: West, street name: Street. Should parse as directional: None, street name: West, street type: Street. TODO: Only checks for two post types in succession, but streets like Park Plaza Drive have three.

pub fn post_type(input: &str) -> IResult<&str, Option<StreetNamePostType>>

The post_type function attempts to parse the next word in the input as a StreetNamePostType value. Since the street name post type is a required field for Grants Pass addresses, there is no need to peek and conditionally return. If the street name post type evaluates to None, this is not a hard error, because the post type is not a required field according to the FGDC standard, and partner agencies such as ECSO may have valid addresses without a street name post type (e.g. “Broadway”).

pub fn is_post_type(input: &str) -> IResult<&str, bool>

The is_post_type function returns true if the input parses to a valid StreetNamePostType. Peeks at the data without consuming it.

pub fn subaddress_type(input: &str) -> IResult<&str, Option<SubaddressType>>

The subaddress_type function attempts to find a word following the street name post type and preceding the postal community. If a word is present, and parses to a subaddress type, the function will return the type and the remainder. If no subaddress type is present, the function will return the full input.

pub fn subaddress_id(input: &str) -> IResult<&str, Option<String>>

The subaddress_id function attempts to find a word following the street name post type and preceding the postal community. If a word is present, and parses to a subaddress type, the function will return the type and the remainder. If no subaddress type is present, the function will return the full input.

pub fn postal_community(input: &str) -> IResult<&str, Option<PostalCommunity>>

The postal_community function attempts to parse the next word in the input as a PostalCommunity value.

pub fn is_postal_community(input: &str) -> IResult<&str, bool>

The is_postal_community function returns true if the input parses to a valid PostalCommunity. Peeks at the data without consuming it.

pub fn state(input: &str) -> IResult<&str, Option<State>>

The state function attempts to parse the next word in the input as a State value.

pub fn is_state(input: &str) -> IResult<&str, bool>

The is_state function returns true if the input parses to a valid State. Peeks at the data without consuming it.

pub fn zip(input: &str) -> IResult<&str, Option<i64>>

The zip function attempts to parse the next word in the input as a postal zip code.

pub fn is_zip(input: &str) -> IResult<&str, bool>

The is_zip function returns true if the input parses to a valid zip code. Peeks at the data without consuming it.

pub fn address(input: &str) -> IResult<&str, PartialAddress>

The address function attempts to read the complete address and parse it into its constituent components.

Trait Implementations

impl Clone for Parse

fn clone(&self) -> Parse

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Parse

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

Formats the value using the given formatter.

impl Copy for Parse