Get Started Contact sales

GooglePlacesSwift Framework Reference

Area

struct Area
 
extension Area : Copyable, CustomStringConvertible, Equatable, Escapable, Hashable, Sendable, SendableMetatype

Area information and the area’s relationship with the target location.

Areas includes precise sublocality, neighborhoods, and large compounds that are useful for describing a location.

  • Returns a Boolean value indicating whether two values are equal.

    Equality is the inverse of inequality. For any values a and b, a == b implies that a != b is false.

    Declaration

    Swift

    static func == (lhs: Area, rhs: Area) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • Defines the spatial relationship between the target location and the area.

    Declaration

    Swift

    enum Containment
     
    extension Area.Containment : Copyable, Equatable, Escapable, Hashable, Sendable, SendableMetatype

  • Defines the spatial relationship between the target location and the area.

    Declaration

    Swift

    var containment: Area.Containment? { get }

  • A textual representation of this instance.

    Calling this property directly is discouraged. Instead, convert an instance of any type to a string by using the String(describing:) initializer. This initializer works with any type, and uses the custom description property for types that conform to CustomStringConvertible:

    struct Point: CustomStringConvertible {
    let x: Int, y: Int

    var description: String {
        return "(\(x), \(y))"
    }
}

let p = Point(x: 21, y: 30)
let s = String(describing: p)
print(s)
// Prints "(21, 30)"

    The conversion of p to a string in the assignment to s uses the Point type’s description property.

    Declaration

    Swift

    var description: String { get }

  • The area’s display name.

    Declaration

    Swift

    var displayName: String? { get }

  • The area’s display name language code.

    Declaration

    Swift

    var displayNameLanguageCode: String? { get }

  • Hashes the essential components of this value by feeding them into the given hasher.

    Implement this method to conform to the Hashable protocol. The components used for hashing must be the same as the components compared in your type’s == operator implementation. Call hasher.combine(_:) with each of these components.

    Important

    In your implementation of hash(into:), don’t call finalize() on the hasher instance provided, or replace it with a different instance. Doing so may become a compile-time error in the future.

    Declaration

    Swift

    func hash(into hasher: inout Hasher)

  • The hash value.

    Hash values are not guaranteed to be equal across different executions of your program. Do not save hash values to use during a future execution.

    Important

    hashValue is deprecated as a Hashable requirement. To conform to Hashable, implement the hash(into:) requirement instead. The compiler provides an implementation for hashValue for you.

    Declaration

    Swift

    var hashValue: Int { get }

  • The area’s place ID.

    Declaration

    Swift

    var placeID: String? { get }

  • The area’s resource name.

    Declaration

    Swift

    var resourceName: String? { get }