JSCalendar.Location (JSCalendar v0.1.0)

Copy Markdown View Source

A physical location (RFC 8984 §4.2.5).

relative_to says which end of the object the location belongs to, which is how an itinerary distinguishes where something starts from where it finishes.

Summary

Types

t()

Functions

from_map(map)

Read this object from a decoded JSON map.

jscalendar_type()

The @type value RFC 8984 gives this object.

to_map(object)

Write this object back to a JSON-ready map.

Types

t()

@type t() :: %JSCalendar.Location{
  coordinates: String.t() | nil,
  description: String.t() | nil,
  extra: map(),
  links: %{optional(String.t()) => JSCalendar.Link.t()} | nil,
  location_types: MapSet.t() | nil,
  name: String.t() | nil,
  relative_to: String.t() | nil,
  time_zone: String.t() | nil
}

Functions

from_map(map)

@spec from_map(map()) :: {:ok, struct()} | {:error, term()}

Read this object from a decoded JSON map.

Arguments

Returns

  • {:ok, object}; or

  • {:error, reason} when a property does not match its declared type.

jscalendar_type()

@spec jscalendar_type() :: String.t()

The @type value RFC 8984 gives this object.

Returns

  • the type name as a string.

to_map(object)

@spec to_map(struct()) :: map()

Write this object back to a JSON-ready map.

Arguments

  • object is a t/0.

Returns