Data.PhoneNumber.LowLevel

Low level phone number handling, more closely matches the underlying libphonenumber API.

Data types

data PhoneNumber

A data type representation of a phone number, you can build one of these with copyPhoneNumberRef.

Constructors

PhoneNumber

Fields

countryCode :: Maybe Word64

nationalNumber :: Maybe Word64

extension :: Maybe ByteString

Instances

Eq PhoneNumber

Show PhoneNumber

data PhoneNumberRef

An opaque pointer to a PhoneNumberRef C++ class

Constructors

PhoneNumberRef

Fields

unPhoneNumberRef :: ForeignPtr PhoneNumberRef

Instances

Show PhoneNumberRef

data PhoneNumberParseError

There was a problem parting your phone number. For now, if you want to know what the Int here means, you'll need to look at the ErrorType enum in the underlying library.

Constructors

PhoneNumberParseError Int

Instances

Eq PhoneNumberParseError

Show PhoneNumberParseError

data PhoneNumberUtil

An opaque pointer to the (singleton) PhoneNumberUtil C++ class

Constructors

PhoneNumberUtil

Fields

unPhoneNumberUtil :: Ptr PhoneNumberUtil

Instances

Show PhoneNumberUtil

data PhoneNumberType

Instances

Enum PhoneNumberType

Eq PhoneNumberType

Show PhoneNumberType

References and parsing

getPhoneNumberUtil :: IO PhoneNumberUtil

Grab the singleton PhoneNumberUtil class instance, needed to do useful things with libphonenumber

newPhoneNumberRef :: IO PhoneNumberRef

Create a mutable reference to a PhoneNumber (C++ class) instance.

parsePhoneNumber

Arguments

:: PhoneNumberUtil

The singleton PhoneNumberUtil reference

-> PhoneNumberRef

The reference to be mutably updated

-> ByteString

The bytestring to parse as a phone number

-> ByteString

The default region to assume numbers are from, if ambiguous. e.g. AU for Australia

-> IO (Either PhoneNumberParseError ())

Parse a phone number.

Utility

unsafeConvertAlphaCharacters :: PhoneNumberUtil -> ByteString -> IO ()

Convert any alpha characters in a phone number to their equivalent keypad numbers.

This modifies the ByteString in place.

Extracting usable information

copyPhoneNumberRef :: PhoneNumberRef -> IO PhoneNumber

Copy fields from a PhoneNumberRef and create a PhoneNumber

getCountryCode :: PhoneNumberRef -> IO (Maybe Word64)

Read the country code from a PhoneNumberRef

getNationalNumber :: PhoneNumberRef -> IO (Maybe Word64)

Read the national number (the phone number itself) from a PhoneNumberRef

getExtension :: PhoneNumberRef -> IO (Maybe ByteString)

Read the extension (e.g. 12345678x123) from a PhoneNumberRef

getType :: PhoneNumberUtil -> PhoneNumberRef -> IO PhoneNumberType