1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343
// Copyright (C) 2017 1aim GmbH // // Licensed under the Apache License, Version 2.0 (the "License"); // you may not use this file except in compliance with the License. // You may obtain a copy of the License at // // http://www.apache.org/licenses/LICENSE-2.0 // // Unless required by applicable law or agreed to in writing, software // distributed under the License is distributed on an "AS IS" BASIS, // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. // See the License for the specific language governing permissions and // limitations under the License. use regex_cache::CachedRegex; use crate::{ metadata::{Format, Descriptor}, phone_number::Type }; /// Phone number metadata. #[derive(Clone, Debug)] pub struct Metadata { pub(crate) descriptors: Descriptors, pub(crate) id: String, pub(crate) country_code: u16, pub(crate) international_prefix: Option<CachedRegex>, pub(crate) preferred_international_prefix: Option<String>, pub(crate) national_prefix: Option<String>, pub(crate) preferred_extension_prefix: Option<String>, pub(crate) national_prefix_for_parsing: Option<CachedRegex>, pub(crate) national_prefix_transform_rule: Option<String>, pub(crate) formats: Vec<Format>, pub(crate) international_formats: Vec<Format>, pub(crate) main_country_for_code: bool, pub(crate) leading_digits: Option<CachedRegex>, pub(crate) mobile_number_portable: bool, } /// Descriptors for various types of phone number. #[derive(Clone, Debug)] pub struct Descriptors { pub(crate) general: Descriptor, pub(crate) fixed_line: Option<Descriptor>, pub(crate) mobile: Option<Descriptor>, pub(crate) toll_free: Option<Descriptor>, pub(crate) premium_rate: Option<Descriptor>, pub(crate) shared_cost: Option<Descriptor>, pub(crate) personal_number: Option<Descriptor>, pub(crate) voip: Option<Descriptor>, pub(crate) pager: Option<Descriptor>, pub(crate) uan: Option<Descriptor>, pub(crate) emergency: Option<Descriptor>, pub(crate) voicemail: Option<Descriptor>, pub(crate) short_code: Option<Descriptor>, pub(crate) standard_rate: Option<Descriptor>, pub(crate) carrier: Option<Descriptor>, pub(crate) no_international: Option<Descriptor>, } impl Metadata { /// Descriptors for the various types of phone number. pub fn descriptors(&self) -> &Descriptors { &self.descriptors } /// The CLDR 2-letter representation of a country/region, with the exception /// of "country calling codes" used for non-geographical entities, such as /// Universal International Toll Free Number (+800). These are all given the /// ID "001", since this is the numeric region code for the world according /// to UN M.49: http://en.wikipedia.org/wiki/UN_M.49 pub fn id(&self) -> &str { &self.id } /// The country calling code that one would dial from overseas when trying to /// dial a phone number in this country. For example, this would be "64" for /// New Zealand. pub fn country_code(&self) -> u16 { self.country_code } /// The international prefix of country A is the number that needs to be /// dialled from country A to another country (country B). This is followed /// by the country code for country B. Note that some countries may have more /// than one international prefix, and for those cases, a regular expression /// matching the international prefixes will be stored in this field. pub fn international_prefix(&self) -> Option<&CachedRegex> { self.international_prefix.as_ref() } /// If more than one international prefix is present, a preferred prefix can /// be specified here for out-of-country formatting purposes. If this field /// is not present, and multiple international prefixes are present, then "+" /// will be used instead. pub fn preferred_international_prefix(&self) -> Option<&str> { self.preferred_extension_prefix.as_ref().map(AsRef::as_ref) } /// The national prefix of country A is the number that needs to be dialled /// before the national significant number when dialling internally. This /// would not be dialled when dialling internationally. For example, in New /// Zealand, the number that would be locally dialled as 09 345 3456 would be /// dialled from overseas as +64 9 345 3456. In this case, 0 is the national /// prefix. pub fn national_prefix(&self) -> Option<&str> { self.national_prefix.as_ref().map(AsRef::as_ref) } /// The preferred prefix when specifying an extension in this country. This /// is used for formatting only, and if this is not specified, a suitable /// default should be used instead. For example, if you wanted extensions to /// be formatted in the following way: /// /// 1 (365) 345 445 ext. 2345 /// " ext. " should be the preferred extension prefix. pub fn preferred_extension_prefix(&self) -> Option<&str> { self.preferred_extension_prefix.as_ref().map(AsRef::as_ref) } /// This field is used for cases where the national prefix of a country /// contains a carrier selection code, and is written in the form of a /// regular expression. For example, to dial the number 2222-2222 in /// Fortaleza, Brazil (area code 85) using the long distance carrier Oi /// (selection code 31), one would dial 0 31 85 2222 2222. Assuming the only /// other possible carrier selection code is 32, the field will contain /// "03[12]". /// /// When it is missing from the XML file, this field inherits the value of /// national prefix, if that is present. pub fn national_prefix_for_parsing(&self) -> Option<&CachedRegex> { self.national_prefix_for_parsing.as_ref() } /// This field is only populated and used under very rare situations. For /// example, mobile numbers in Argentina are written in two completely /// different ways when dialed in-country and out-of-country (e.g. 0343 15 /// 555 1212 is exactly the same number as +54 9 343 555 1212). /// /// This field is used together with `national_prefix_for_parsing` to transform /// the number into a particular representation for storing in the /// phonenumber proto buffer in those rare cases. pub fn national_prefix_transform_rule(&self) -> Option<&str> { self.national_prefix_transform_rule.as_ref().map(AsRef::as_ref) } /// Note that the number format here is used for formatting only, not /// parsing. Hence all the varied ways a user *may* write a number need not /// be recorded - just the ideal way we would like to format it for them. /// /// When this element is absent, the national significant number will be /// formatted as a whole without any formatting applied. pub fn formats(&self) -> &[Format] { &self.formats } /// This field is populated only when the national significant number is /// formatted differently when it forms part of the INTERNATIONAL format and /// NATIONAL format. A case in point is mobile numbers in Argentina: The /// number, which would be written in INTERNATIONAL format as +54 9 343 555 /// 1212, will be written as 0343 15 555 1212 for NATIONAL format. In this /// case, the prefix 9 is inserted when dialling from overseas, but otherwise /// the prefix 0 and the carrier selection code /// 15 (inserted after the area code of 343) is used. /// /// Note: this field is populated by setting a value for <intlFormat> inside /// the <numberFormat> tag in the XML file. If <intlFormat> is not set then /// it defaults to the same value as the <format> tag. /// /// Examples: /// To set the <intlFormat> to a different value than the <format>: /// <numberFormat pattern=....> /// <format>$1 $2 $3</format> /// <intlFormat>$1-$2-$3</intlFormat> /// </numberFormat> /// /// To have a format only used for national formatting, set <intlFormat> to /// "NA": /// <numberFormat pattern=....> /// <format>$1 $2 $3</format> /// <intlFormat>NA</intlFormat> /// </numberFormat> pub fn international_formats(&self) -> &[Format] { &self.international_formats } /// This field is set when this country is considered to be the main country /// for a calling code. It may not be set by more than one country with the /// same calling code, and it should not be set by countries with a unique /// calling code. This can be used to indicate that "GB" is the main country /// for the calling code "44" for example, rather than Jersey or the Isle of /// Man. pub fn is_main_country_for_code(&self) -> bool { self.main_country_for_code } /// This field is populated only for countries or regions that share a /// country calling code. If a number matches this pattern, it could belong /// to this region. This is not intended as a replacement for /// IsValidForRegion since a matching prefix is insufficient for a number to /// be valid. Furthermore, it does not contain all the prefixes valid for a /// region - for example, 800 numbers are valid for all NANPA countries and /// are hence not listed here. /// /// This field should be a regular expression of the expected prefix match. /// /// It is used merely as a short-cut for working out which region a number /// comes from in the case that there is only one, so leading digit prefixes /// should not overlap. pub fn leading_digits(&self) -> Option<&CachedRegex> { self.leading_digits.as_ref() } /// This field is set when this country has implemented mobile number /// portability. This means that transferring mobile numbers between carriers /// is allowed. A consequence of this is that phone prefix to carrier mapping /// is less reliable. pub fn is_mobile_number_portable(&self) -> bool { self.mobile_number_portable } } impl Descriptors { /// Get the proper descriptor for the given phone number type, if any. pub fn get(&self, kind: Type) -> Option<&Descriptor> { match kind { Type::Unknown => Some(&self.general), Type::FixedLine | Type::FixedLineOrMobile => self.fixed_line.as_ref(), Type::Mobile => self.mobile.as_ref(), Type::TollFree => self.toll_free.as_ref(), Type::PremiumRate => self.premium_rate.as_ref(), Type::SharedCost => self.shared_cost.as_ref(), Type::PersonalNumber => self.personal_number.as_ref(), Type::Voip => self.voip.as_ref(), Type::Pager => self.pager.as_ref(), Type::Uan => self.uan.as_ref(), Type::Emergency => self.emergency.as_ref(), Type::Voicemail => self.voicemail.as_ref(), Type::ShortCode => self.short_code.as_ref(), Type::StandardRate => self.standard_rate.as_ref(), Type::Carrier => self.carrier.as_ref(), Type::NoInternational => self.no_international.as_ref(), } } pub fn general(&self) -> &Descriptor { &self.general } pub fn fixed_line(&self) -> Option<&Descriptor> { self.fixed_line.as_ref() } pub fn mobile(&self) -> Option<&Descriptor> { self.mobile.as_ref() } pub fn toll_free(&self) -> Option<&Descriptor> { self.toll_free.as_ref() } pub fn premium_rate(&self) -> Option<&Descriptor> { self.premium_rate.as_ref() } pub fn shared_cost(&self) -> Option<&Descriptor> { self.shared_cost.as_ref() } pub fn personal_number(&self) -> Option<&Descriptor> { self.personal_number.as_ref() } pub fn voip(&self) -> Option<&Descriptor> { self.voip.as_ref() } pub fn pager(&self) -> Option<&Descriptor> { self.pager.as_ref() } pub fn uan(&self) -> Option<&Descriptor> { self.uan.as_ref() } pub fn emergency(&self) -> Option<&Descriptor> { self.emergency.as_ref() } pub fn voicemail(&self) -> Option<&Descriptor> { self.voicemail.as_ref() } pub fn short_code(&self) -> Option<&Descriptor> { self.short_code.as_ref() } pub fn standard_rate(&self) -> Option<&Descriptor> { self.standard_rate.as_ref() } pub fn carrier(&self) -> Option<&Descriptor> { self.carrier.as_ref() } pub fn no_international(&self) -> Option<&Descriptor> { self.no_international.as_ref() } }