GooglePlacesSwift Framework Reference

AI-generated Key Takeaways

• Period represents the operational hours of a place, containing open and optional close events.

• If a place is open 24 hours, the close event will be nil, and the open event will have a time of "0000".

• Period conforms to CustomStringConvertible, Equatable, and Hashable protocols for description, comparison, and hashing functionalities.

• The description property provides a textual representation of the Period instance.

• hash(into:) and the deprecated hashValue are used for hashing in accordance with the Hashable protocol.

Period

struct Period

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

A type representing a period of time where the place is operating for a Place.

Contains an open Event and an optional close Event. The close event will be nil if the period is open 24hrs.

• ==(_:_:)

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

  Parameters

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

• close

  The close event of this period. Can be nil if period is open 24hrs.

  Declaration

  Swift

  let close: Event?

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

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

• open

  The open event of this period.

  Each Period is guaranteed to have an open event. If the period is representing open 24hrs, it will only have the open Event with time as “0000”.

  Declaration

  Swift

  let open: Event