Safe Haskell	Safe-Inferred
Language	Haskell2010

Data.PhoneNumber.Number

Description

Data fields of PhoneNumber objects.

Synopsis

data PhoneNumber
pattern PhoneNumber :: Maybe ByteString -> Maybe ByteString -> Maybe ByteString -> Word -> CountryCode -> Maybe Bool -> Maybe CountryCodeSource -> Maybe Int -> PhoneNumber
extension :: PhoneNumber -> Maybe ByteString
rawInput :: PhoneNumber -> Maybe ByteString
preferredDomesticCarrierCode :: PhoneNumber -> Maybe ByteString
nationalNumber :: PhoneNumber -> Word
countryCode :: PhoneNumber -> CountryCode
italianLeadingZero :: PhoneNumber -> Maybe Bool
countryCodeSource :: PhoneNumber -> Maybe CountryCodeSource
numberOfLeadingZeros :: PhoneNumber -> Maybe Int
newtype CountryCode = CountryCode Int
data CountryCodeSource

Documentation

data PhoneNumber Source #

A decoded phone number. While internally it is a handle for the corresponding C++ object, for most intents and purposes it can be used as a record (using the PhoneNumber record pattern synonym) with the following structure:

PhoneNumber
{ extension :: !(Maybe ByteString)
, rawInput :: !(Maybe ByteString)
, preferredDomesticCarrierCode :: !(Maybe ByteString)
, nationalNumber :: !Word
, countryCode :: ! CountryCode
, italianLeadingZero :: !(Maybe Bool)
, countryCodeSource :: !(Maybe CountryCodeSource)
, numberOfLeadingZeros :: !(Maybe Int)
}

Instances

Instances details

Data PhoneNumber Source #	No internal structure
Instance details Defined in Data.PhoneNumber.Internal.Number Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> PhoneNumber -> c PhoneNumber # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c PhoneNumber # toConstr :: PhoneNumber -> Constr # dataTypeOf :: PhoneNumber -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c PhoneNumber) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c PhoneNumber) # gmapT :: (forall b. Data b => b -> b) -> PhoneNumber -> PhoneNumber # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> PhoneNumber -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> PhoneNumber -> r # gmapQ :: (forall d. Data d => d -> u) -> PhoneNumber -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> PhoneNumber -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> PhoneNumber -> m PhoneNumber # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> PhoneNumber -> m PhoneNumber # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> PhoneNumber -> m PhoneNumber #
Read PhoneNumber Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods readsPrec :: Int -> ReadS PhoneNumber # readList :: ReadS [PhoneNumber] # readPrec :: ReadPrec PhoneNumber # readListPrec :: ReadPrec [PhoneNumber] #
Show PhoneNumber Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods showsPrec :: Int -> PhoneNumber -> ShowS # show :: PhoneNumber -> String # showList :: [PhoneNumber] -> ShowS #
NFData PhoneNumber Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods rnf :: PhoneNumber -> () #
Eq PhoneNumber Source #	Compares all the data fields, consider `matchNumbers` instead
Instance details Defined in Data.PhoneNumber.Internal.Number Methods (==) :: PhoneNumber -> PhoneNumber -> Bool # (/=) :: PhoneNumber -> PhoneNumber -> Bool #
Ord PhoneNumber Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods compare :: PhoneNumber -> PhoneNumber -> Ordering # (<) :: PhoneNumber -> PhoneNumber -> Bool # (<=) :: PhoneNumber -> PhoneNumber -> Bool # (>) :: PhoneNumber -> PhoneNumber -> Bool # (>=) :: PhoneNumber -> PhoneNumber -> Bool # max :: PhoneNumber -> PhoneNumber -> PhoneNumber # min :: PhoneNumber -> PhoneNumber -> PhoneNumber #

pattern PhoneNumber :: Maybe ByteString -> Maybe ByteString -> Maybe ByteString -> Word -> CountryCode -> Maybe Bool -> Maybe CountryCodeSource -> Maybe Int -> PhoneNumber Source #

Record pattern synonym for accessing data fields of the underlying C++ object. It can be used for record construction, record update, and record pattern match. See PhoneNumber.

extension :: PhoneNumber -> Maybe ByteString Source #

E.g.:

parseNumber Canonicalize Nothing "+1 800-234-5678 ext. 1234"
= Right PhoneNumber { extension = Just "1234", .. }

rawInput :: PhoneNumber -> Maybe ByteString Source #

E.g.:

parseNumber KeepRawInput Nothing " + 1(2-3~4*5.6 "
= Right PhoneNumber { rawInput = Just " + 1(2-3~4*5.6 ", .. }

preferredDomesticCarrierCode :: PhoneNumber -> Maybe ByteString Source #

E.g.:

parseNumber KeepRawInput (Just "BR") "0 41 (21) 2345-6789"
= Right PhoneNumber { preferredDomesticCarrierCode = Just "41", .. }

nationalNumber :: PhoneNumber -> Word Source #

You probably want to use nationalSignificantNumber instead. E.g.:

parseNumber Canonicalize Nothing "+800 0001 2345"
= Right PhoneNumber { nationalNumber = 12345, numberOfLeadingZeros = Just 3, .. }

countryCode :: PhoneNumber -> CountryCode Source #

E.g.:

parseNumber Canonicalize (Just "US") "800-234-5678"
= Right PhoneNumber { countryCode = 1, .. }

italianLeadingZero :: PhoneNumber -> Maybe Bool Source #

E.g.:

parseNumber Canonicalize Nothing "+39 06 1234 5678"
= Right PhoneNumber { italianLeadingZero = Just True, .. }

countryCodeSource :: PhoneNumber -> Maybe CountryCodeSource Source #

E.g.:

parseNumber KeepRawInput (Just "US") "011 800 1234 5678"
= Right PhoneNumber { countryCodeSource = Just FromNumberWithIdd, .. }

numberOfLeadingZeros :: PhoneNumber -> Maybe Int Source #

E.g.:

parseNumber Canonicalize Nothing "+800 0001 2345"
= Right PhoneNumber { numberOfLeadingZeros = Just 3, nationalNumber = 12345, .. }

newtype CountryCode Source #

A country calling code (International Subscriber Dialing code, ISD code), e.g. 34 for Spain.

Contrary to the name, doesn't always correspond to a unique country (e.g. 7 could be either Russia or Kazakhstan), or a country at all, and instead a non-geographical entity (e.g. 800 is a Universal International Freephone Service dialing code).

Constructors

CountryCode Int

Instances

Instances details

Num CountryCode Source #
Instance details Defined in Data.PhoneNumber.Number Methods (+) :: CountryCode -> CountryCode -> CountryCode # (-) :: CountryCode -> CountryCode -> CountryCode # (*) :: CountryCode -> CountryCode -> CountryCode # negate :: CountryCode -> CountryCode # abs :: CountryCode -> CountryCode # signum :: CountryCode -> CountryCode # fromInteger :: Integer -> CountryCode #
Show CountryCode Source #
Instance details Defined in Data.PhoneNumber.Number Methods showsPrec :: Int -> CountryCode -> ShowS # show :: CountryCode -> String # showList :: [CountryCode] -> ShowS #
Eq CountryCode Source #
Instance details Defined in Data.PhoneNumber.Number Methods (==) :: CountryCode -> CountryCode -> Bool # (/=) :: CountryCode -> CountryCode -> Bool #
Ord CountryCode Source #
Instance details Defined in Data.PhoneNumber.Number Methods compare :: CountryCode -> CountryCode -> Ordering # (<) :: CountryCode -> CountryCode -> Bool # (<=) :: CountryCode -> CountryCode -> Bool # (>) :: CountryCode -> CountryCode -> Bool # (>=) :: CountryCode -> CountryCode -> Bool # max :: CountryCode -> CountryCode -> CountryCode # min :: CountryCode -> CountryCode -> CountryCode #

data CountryCodeSource Source #

Indicates what information was used to fill the countryCode field of PhoneNumber.

Constructors

Unspecified
FromNumberWithPlusSign
FromNumberWithIdd
FromNumberWithoutPlusSign
FromDefaultCountry

Instances

Instances details

Data CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> CountryCodeSource -> c CountryCodeSource # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c CountryCodeSource # toConstr :: CountryCodeSource -> Constr # dataTypeOf :: CountryCodeSource -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c CountryCodeSource) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c CountryCodeSource) # gmapT :: (forall b. Data b => b -> b) -> CountryCodeSource -> CountryCodeSource # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> CountryCodeSource -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> CountryCodeSource -> r # gmapQ :: (forall d. Data d => d -> u) -> CountryCodeSource -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> CountryCodeSource -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> CountryCodeSource -> m CountryCodeSource # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> CountryCodeSource -> m CountryCodeSource # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> CountryCodeSource -> m CountryCodeSource #
Enum CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods succ :: CountryCodeSource -> CountryCodeSource # pred :: CountryCodeSource -> CountryCodeSource # toEnum :: Int -> CountryCodeSource # fromEnum :: CountryCodeSource -> Int # enumFrom :: CountryCodeSource -> [CountryCodeSource] # enumFromThen :: CountryCodeSource -> CountryCodeSource -> [CountryCodeSource] # enumFromTo :: CountryCodeSource -> CountryCodeSource -> [CountryCodeSource] # enumFromThenTo :: CountryCodeSource -> CountryCodeSource -> CountryCodeSource -> [CountryCodeSource] #
Generic CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Associated Types type Rep CountryCodeSource :: Type -> Type # Methods from :: CountryCodeSource -> Rep CountryCodeSource x # to :: Rep CountryCodeSource x -> CountryCodeSource #
Read CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods readsPrec :: Int -> ReadS CountryCodeSource # readList :: ReadS [CountryCodeSource] # readPrec :: ReadPrec CountryCodeSource # readListPrec :: ReadPrec [CountryCodeSource] #
Show CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods showsPrec :: Int -> CountryCodeSource -> ShowS # show :: CountryCodeSource -> String # showList :: [CountryCodeSource] -> ShowS #
NFData CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods rnf :: CountryCodeSource -> () #
Eq CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods (==) :: CountryCodeSource -> CountryCodeSource -> Bool # (/=) :: CountryCodeSource -> CountryCodeSource -> Bool #
Ord CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number Methods compare :: CountryCodeSource -> CountryCodeSource -> Ordering # (<) :: CountryCodeSource -> CountryCodeSource -> Bool # (<=) :: CountryCodeSource -> CountryCodeSource -> Bool # (>) :: CountryCodeSource -> CountryCodeSource -> Bool # (>=) :: CountryCodeSource -> CountryCodeSource -> Bool # max :: CountryCodeSource -> CountryCodeSource -> CountryCodeSource # min :: CountryCodeSource -> CountryCodeSource -> CountryCodeSource #
type Rep CountryCodeSource Source #
Instance details Defined in Data.PhoneNumber.Internal.Number type Rep CountryCodeSource = D1 ('MetaData "CountryCodeSource" "Data.PhoneNumber.Internal.Number" "libphonenumber-0.1.0.0-inplace" 'False) ((C1 ('MetaCons "Unspecified" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FromNumberWithPlusSign" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "FromNumberWithIdd" 'PrefixI 'False) (U1 :: Type -> Type) :+: (C1 ('MetaCons "FromNumberWithoutPlusSign" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "FromDefaultCountry" 'PrefixI 'False) (U1 :: Type -> Type))))