StructureFoundationEssentials
Locale.Region
iOS 16.0+
iPadOS 16.0+
Mac Catalyst 16.0+
macOS 13.0+
tvOS 16.0+
watchOS 9.0+
A type that represents a geographic region, for use in specifying a locale or language.
struct Region
Topics
Structures
struct CategoryCategories of a region. See https://www.unicode.org/reports/tr35/tr35-35/tr35-info.html#Territory_Data
Operators
Initializers
init(String)Creates a region from a BCP 47 identifier.init(from: any Decoder) throwsinit(stringLiteral: String)Creates a region from a BCP 47 identifier as a string literal.
Instance Properties
var category: Locale.Region.Category?The category of the region.var containingRegion: Locale.Region?The region that contains this region, if any.var continent: Locale.Region?The continent that contains this region, if any.var debugDescription: Stringvar identifier: StringThe BCP 47 identifier of the region.var isISORegion: BoolA Boolean value that indicates whether the region is an ISO-defined region.var subRegions: [Locale.Region]An array of all the sub-regions of the region.var subcontinent: Locale.Region?The subcontinent that contains this region, if any.
Instance Methods
func encode(to: any Encoder) throwsfunc hash(into: inout Hasher)func subRegions(ofCategory: Locale.Region.Category) -> [Locale.Region]An array of the sub-regions, matching the specified category of the region.
Type Properties
static var ålandIslands: Locale.Regionstatic var afghanistan: Locale.Regionstatic var albania: Locale.Regionstatic var algeria: Locale.Regionstatic var americanSamoa: Locale.Regionstatic var andorra: Locale.Regionstatic var angola: Locale.Regionstatic var anguilla: Locale.Regionstatic var antarctica: Locale.Regionstatic var antiguaBarbuda: Locale.Regionstatic var argentina: Locale.Regionstatic var armenia: Locale.Regionstatic var aruba: Locale.Regionstatic var ascensionIsland: Locale.Regionstatic var australia: Locale.Regionstatic var austria: Locale.Regionstatic var azerbaijan: Locale.Regionstatic var bahamas: Locale.Regionstatic var bahrain: Locale.Regionstatic var bangladesh: Locale.Regionstatic var barbados: Locale.Regionstatic var belarus: Locale.Regionstatic var belgium: Locale.Regionstatic var belize: Locale.Regionstatic var benin: Locale.Regionstatic var bermuda: Locale.Regionstatic var bhutan: Locale.Regionstatic var bolivia: Locale.Regionstatic var bosniaHerzegovina: Locale.Regionstatic var botswana: Locale.Regionstatic var bouvetIsland: Locale.Regionstatic var brazil: Locale.Regionstatic var britishVirginIslands: Locale.Regionstatic var brunei: Locale.Regionstatic var bulgaria: Locale.Regionstatic var burkinaFaso: Locale.Regionstatic var burundi: Locale.Regionstatic var côteDIvoire: Locale.Regionstatic var cambodia: Locale.Regionstatic var cameroon: Locale.Regionstatic var canada: Locale.Regionstatic var canaryIslands: Locale.Regionstatic var capeVerde: Locale.Regionstatic var caribbeanNetherlands: Locale.Regionstatic var caymanIslands: Locale.Regionstatic var centralAfricanRepublic: Locale.Regionstatic var ceutaMelilla: Locale.Regionstatic var chad: Locale.Regionstatic var chagosArchipelago: Locale.Regionstatic var chile: Locale.Regionstatic var chinaMainland: Locale.Regionstatic var christmasIsland: Locale.Regionstatic var clippertonIsland: Locale.Regionstatic var cocosIslands: Locale.Regionstatic var colombia: Locale.Regionstatic var comoros: Locale.Regionstatic var congoBrazzaville: Locale.Regionstatic var congoKinshasa: Locale.Regionstatic var cookIslands: Locale.Regionstatic var costaRica: Locale.Regionstatic var croatia: Locale.Regionstatic var cuba: Locale.Regionstatic var curaçao: Locale.Regionstatic var cyprus: Locale.Regionstatic var czechia: Locale.Regionstatic var denmark: Locale.Regionstatic var diegoGarcia: Locale.Regionstatic var djibouti: Locale.Regionstatic var dominica: Locale.Regionstatic var dominicanRepublic: Locale.Regionstatic var ecuador: Locale.Regionstatic var egypt: Locale.Regionstatic var elSalvador: Locale.Regionstatic var equatorialGuinea: Locale.Regionstatic var eritrea: Locale.Regionstatic var estonia: Locale.Regionstatic var eswatini: Locale.Regionstatic var ethiopia: Locale.Regionstatic var falklandIslands: Locale.Regionstatic var faroeIslands: Locale.Regionstatic var fiji: Locale.Regionstatic var finland: Locale.Regionstatic var france: Locale.Regionstatic var frenchGuiana: Locale.Regionstatic var frenchPolynesia: Locale.Regionstatic var frenchSouthernTerritories: Locale.Regionstatic var gabon: Locale.Regionstatic var gambia: Locale.Regionstatic var georgia: Locale.Regionstatic var germany: Locale.Regionstatic var ghana: Locale.Regionstatic var gibraltar: Locale.Regionstatic var greece: Locale.Regionstatic var greenland: Locale.Regionstatic var grenada: Locale.Regionstatic var guadeloupe: Locale.Regionstatic var guam: Locale.Regionstatic var guatemala: Locale.Regionstatic var guernsey: Locale.Regionstatic var guinea: Locale.Regionstatic var guineaBissau: Locale.Regionstatic var guyana: Locale.Regionstatic var haiti: Locale.Regionstatic var heardMcdonaldIslands: Locale.Regionstatic var honduras: Locale.Regionstatic var hongKong: Locale.Regionstatic var hungary: Locale.Regionstatic var iceland: Locale.Regionstatic var india: Locale.Regionstatic var indonesia: Locale.Regionstatic var iran: Locale.Regionstatic var iraq: Locale.Regionstatic var ireland: Locale.Regionstatic var isleOfMan: Locale.Regionstatic var isoRegions: [Locale.Region]An array of regions defined by ISO.static var israel: Locale.Regionstatic var italy: Locale.Regionstatic var jamaica: Locale.Regionstatic var japan: Locale.Regionstatic var jersey: Locale.Regionstatic var jordan: Locale.Regionstatic var kazakhstan: Locale.Regionstatic var kenya: Locale.Regionstatic var kiribati: Locale.Regionstatic var kosovo: Locale.Regionstatic var kuwait: Locale.Regionstatic var kyrgyzstan: Locale.Regionstatic var laos: Locale.Regionstatic var latinAmerica: Locale.Regionstatic var latvia: Locale.Regionstatic var lebanon: Locale.Regionstatic var lesotho: Locale.Regionstatic var liberia: Locale.Regionstatic var libya: Locale.Regionstatic var liechtenstein: Locale.Regionstatic var lithuania: Locale.Regionstatic var luxembourg: Locale.Regionstatic var macao: Locale.Regionstatic var madagascar: Locale.Regionstatic var malawi: Locale.Regionstatic var malaysia: Locale.Regionstatic var maldives: Locale.Regionstatic var mali: Locale.Regionstatic var malta: Locale.Regionstatic var marshallIslands: Locale.Regionstatic var martinique: Locale.Regionstatic var mauritania: Locale.Regionstatic var mauritius: Locale.Regionstatic var mayotte: Locale.Regionstatic var mexico: Locale.Regionstatic var micronesia: Locale.Regionstatic var moldova: Locale.Regionstatic var monaco: Locale.Regionstatic var mongolia: Locale.Regionstatic var montenegro: Locale.Regionstatic var montserrat: Locale.Regionstatic var morocco: Locale.Regionstatic var mozambique: Locale.Regionstatic var myanmar: Locale.Regionstatic var namibia: Locale.Regionstatic var nauru: Locale.Regionstatic var nepal: Locale.Regionstatic var netherlands: Locale.Regionstatic var newCaledonia: Locale.Regionstatic var newZealand: Locale.Regionstatic var nicaragua: Locale.Regionstatic var niger: Locale.Regionstatic var nigeria: Locale.Regionstatic var niue: Locale.Regionstatic var norfolkIsland: Locale.Regionstatic var northMacedonia: Locale.Regionstatic var northernMarianaIslands: Locale.Regionstatic var norway: Locale.Regionstatic var oman: Locale.Regionstatic var pakistan: Locale.Regionstatic var palau: Locale.Regionstatic var palestinianTerritories: Locale.Regionstatic var panama: Locale.Regionstatic var papuaNewGuinea: Locale.Regionstatic var paraguay: Locale.Regionstatic var peru: Locale.Regionstatic var philippines: Locale.Regionstatic var pitcairnIslands: Locale.Regionstatic var poland: Locale.Regionstatic var portugal: Locale.Regionstatic var puertoRico: Locale.Regionstatic var qatar: Locale.Regionstatic var réunion: Locale.Regionstatic var romania: Locale.Regionstatic var russia: Locale.Regionstatic var rwanda: Locale.Regionstatic var sãoToméPríncipe: Locale.Regionstatic var saintBarthélemy: Locale.Regionstatic var saintHelena: Locale.Regionstatic var saintKittsNevis: Locale.Regionstatic var saintLucia: Locale.Regionstatic var saintMartin: Locale.Regionstatic var saintPierreMiquelon: Locale.Regionstatic var saintVincentGrenadines: Locale.Regionstatic var samoa: Locale.Regionstatic var sanMarino: Locale.Regionstatic var saudiArabia: Locale.Regionstatic var senegal: Locale.Regionstatic var serbia: Locale.Regionstatic var seychelles: Locale.Regionstatic var sierraLeone: Locale.Regionstatic var singapore: Locale.Regionstatic var sintMaarten: Locale.Regionstatic var slovakia: Locale.Regionstatic var slovenia: Locale.Regionstatic var solomonIslands: Locale.Regionstatic var somalia: Locale.Regionstatic var southAfrica: Locale.Regionstatic var southGeorgiaSouthSandwichIslands: Locale.Regionstatic var southKorea: Locale.Regionstatic var southSudan: Locale.Regionstatic var spain: Locale.Regionstatic var sriLanka: Locale.Regionstatic var suriname: Locale.Regionstatic var svalbardJanMayen: Locale.Regionstatic var sweden: Locale.Regionstatic var switzerland: Locale.Regionstatic var taiwan: Locale.Regionstatic var tajikistan: Locale.Regionstatic var tanzania: Locale.Regionstatic var thailand: Locale.Regionstatic var timorLeste: Locale.Regionstatic var togo: Locale.Regionstatic var tokelau: Locale.Regionstatic var tonga: Locale.Regionstatic var trinidadTobago: Locale.Regionstatic var tristanDaCunha: Locale.Regionstatic var tunisia: Locale.Regionstatic var turkey: Locale.Regionstatic var turkmenistan: Locale.Regionstatic var turksCaicosIslands: Locale.Regionstatic var tuvalu: Locale.Regionstatic var uganda: Locale.Regionstatic var ukraine: Locale.Regionstatic var unitedArabEmirates: Locale.Regionstatic var unitedKingdom: Locale.Regionstatic var unitedStates: Locale.Regionstatic var unitedStatesOutlyingIslands: Locale.Regionstatic var unitedStatesVirginIslands: Locale.Regionstatic let unknown: Locale.RegionA pre-defined unknown or invalid region.static var uruguay: Locale.Regionstatic var uzbekistan: Locale.Regionstatic var vanuatu: Locale.Regionstatic var vaticanCity: Locale.Regionstatic var venezuela: Locale.Regionstatic var vietnam: Locale.Regionstatic var wallisFutuna: Locale.Regionstatic var westernSahara: Locale.Regionstatic var world: Locale.Regionstatic var yemen: Locale.Regionstatic var zambia: Locale.Regionstatic var zimbabwe: Locale.Region
Type Methods
static func isoRegions(ofCategory: Locale.Region.Category) -> [Locale.Region]An array of regions matching the specified categories.
Relationships
Conforms To
Swift.CopyableSwift.CustomDebugStringConvertibleSwift.DecodableSwift.EncodableSwift.EquatableSwift.EscapableSwift.ExpressibleByExtendedGraphemeClusterLiteralSwift.ExpressibleByStringLiteralSwift.ExpressibleByUnicodeScalarLiteralSwift.HashableSwift.SendableSwift.SendableMetatype