GooglePlacesSwift Framework Reference

AddressComponent

struct AddressComponent
extension AddressComponent : CustomStringConvertible, Equatable, Hashable

Represents a component of an address, e.g., street number, postcode, city, etc.

  • 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: AddressComponent, rhs: AddressComponent) -> Bool

    Parameters

    lhs

    A value to compare.
    rhs

    Another value to compare.

  • 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 }

  • 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 }

  • Instantiates an AddressComponent with the specified information.

    AddressComponents can be gotten from a Place object. This initializer can be used for testing.

    Declaration

    Swift

    init(types: Set<PlaceType>, name: String, shortName: String? = nil)

    Return Value

    An AddressComponent containing the specified information.

  • Name of the address component, e.g. “Sydney”

    Declaration

    Swift

    var name: String { get }

  • Short name of the address component, e.g. “AU”

    Declaration

    Swift

    var shortName: String? { get }

  • Types associated with the address component. For a list of supported types, see https://developers.google.com/places/ios-sdk/supported_types#table2. This set will contain one or more PlaceType defined in PlaceTypes.swift.

    Declaration

    Swift

    var types: Set<PlaceType> { get }