Struct usps_api::USPSWebTool

pub struct USPSWebTool { /* fields omitted */ }

This struct is how you will make API calls to the USPS. It can be initialized with a hardcoded user_id and password using the 'init' contructor or it can attempt to capture these values from the environment (USPS_USER_ID and USPS_PASSWORD respectively) using the 'new' constructor.

Methods

impl USPSWebTool

pub fn init(user_id: &str, password: &str) -> Self

Used to build a new USPSWebTool struct by specifying the USPS authentication credentials directly."

Example

let usps_api = USPSWebTool::init("XXXX", "YYYY");

pub fn new() -> Result<Self, VarError>

Used to build a new USPSWebTool struct by looking at the environment variables "USPS_USER_ID" and "USPS_PASSWORD to specify the USPS authentication credentials."

Example

env::set_var("USPS_USER_ID", "XXXX");
env::set_var("USPS_PASSWORD", "YYYY");
let usps_api = USPSWebTool::new()?;

pub fn use_http(self) -> Self

Will use the unsecured endpoint for communication with the USPS API. This feature is not recommended.

Example

let usps_api = USPSWebTool::init("XXXX", "YYYY").use_http();

pub fn verify_address(
    &self,
    address: USPSAddress
) -> Result<USPSAddress, Box<dyn Error>>

Accepts a USPS Address and returns a result with the 'correct' form of the address.

Trait Implementations

impl PartialEq<USPSWebTool> for USPSWebTool

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

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

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

This method tests for !=.

impl Debug for USPSWebTool

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

Formats the value using the given formatter.