Exosphere.Community.Location.Hthree (Exosphere v0.6.0)

A physical location in the form of a H3 encoded location.

Object schema community.lexicon.location.hthree.

Fields

t()

from_map(map)

Decode a wire-format map. Delegates to new/1.

new(attrs)

Build and validate from a map of attrs (atom or wire string keys).

new!(attrs)

Build and validate, raising ArgumentError on error.

to_map(struct)

Encode to the wire-format map.

type_id()

The lexicon type ID (nsid or nsid#def) this module was generated from.

@type t() :: %Exosphere.Community.Location.Hthree{
  extra: term(),
  name: String.t() | nil,
  value: String.t()
}

@spec from_map(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Decode a wire-format map. Delegates to new/1.

@spec new(map()) ::
  {:ok, t()} | {:error, [{path :: String.t(), message :: String.t()}]}

Build and validate from a map of attrs (atom or wire string keys).

Unknown keys are kept in extra and re-emitted by to_map/1.

@spec new!(map()) :: t()

Build and validate, raising ArgumentError on error.

@spec to_map(t()) :: map()

Encode to the wire-format map.

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

The lexicon type ID (nsid or nsid#def) this module was generated from.