GooglePlacesSwift Framework Reference

AI-generated Key Takeaways

• PlusCode stores the Plus codes representation for a location, offering both global and compound code formats.

• It conforms to CustomStringConvertible, Equatable, and Hashable protocols, enabling textual representation, comparison, and hashing functionalities.

• The globalCode property provides the geo plus code (e.g., "8FVC9G8F+5W"), while the optional compoundCode property gives a human-readable format (e.g., "9G8F+5W Zurich, Switzerland").

• You can create a PlusCode instance using the designated initializer by providing the global code and, optionally, the compound code.

PlusCode

struct PlusCode

extension PlusCode : Copyable, CustomStringConvertible, Equatable, Escapable, Hashable, Sendable

A class containing the Plus codes representation for a location.

See https://plus.codes/ for more details.

• ==(_:_:)

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

  Parameters

  lhs	A value to compare.
  rhs	Another value to compare.

• compoundCode

  Compound plus code, e.g. “9G8F+5W Zurich, Switzerland”

  Declaration

  Swift

  var compoundCode: String? { get }

• description

  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 }

• globalCode

  Geo plus code, e.g. “8FVC9G8F+5W”.

  Declaration

  Swift

  var globalCode: String { get }

• hash(into:)

  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)

• hashValue

  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 }

• init(globalCode:compoundCode:)

  Instantiates a PlusCode with the specified information.

  This initializer can be used for testing.

  Declaration

  Swift

  init(globalCode: String, compoundCode: String? = nil)

  Parameters

  globalCode	Geo plus code, e.g. “8FVC9G8F+5W”.
  compoundCode	Compound plus code, e.g. “9G8F+5W Zurich, Switzerland”. Defaults to nil.

  Return Value

  A PlusCode containing the specified information.