Struct authy::phone::Phone

pub struct Phone {
    pub country_code: u16,
    pub phone_number: String,
    pub phone_type: String,
    pub provider: Option<String>,
    pub ported: bool,
}

Returned when finding a phone number.

Please see api::phone for more details.

Fields

country_code: u16

phone_number: String

phone_type: String

provider: Option<String>

ported: bool

Implementations

impl Phone

pub fn find(
    c: &Client,
    country_code: u16,
    phone: &str
) -> Result<Phone, AuthyError>

Request information on a phone number.

Please see api::phone::info for more details.

pub fn start(
    &self,
    c: &Client,
    via: ContactType,
    code_length: Option<u8>,
    locale: Option<&str>
) -> Result<PhoneStart, AuthyError>

Initiate a phone verification check.

Please see api::phone::start for more details.

pub fn check(&self, c: &Client, code: &str) -> Result<(), AuthyError>

Verify phone verification code sent to user.

Please see api::phone::check for more details.

Trait Implementations

impl Clone for Phone

fn clone(&self) -> Phone

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Phone

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

Formats the value using the given formatter.

impl Default for Phone

fn default() -> Phone

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Phone

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<Phone> for Phone

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

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

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

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

impl Serialize for Phone

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

Serialize this value into the given Serde serializer.

impl Eq for Phone

impl StructuralEq for Phone

impl StructuralPartialEq for Phone