StrawHat.Map v1.0.0 StrawHat.Map.State View Source

Represents a State Ecto Schema with functionality about the data validation for State.

Link to this section Summary

Types

state_attrs()

Check t/0 type for more information about the keys

t()

name: Name of the state.
code: Code of the state.
country: StrawHat.Map.Country.t/0 associated with the current state.
country_id: id of StrawHat.Map.Country.t/0 associated with the state.
counties: List of StrawHat.Map.County.t/0 associated with the current state.
cities: List of StrawHat.Map.City.t/0 associated with the current state

Functions

changeset(state, state_attrs)

Validates the attributes and return a Ecto.Changeset for the current State

Link to this section Types

state_attrs()

state_attrs() :: %{name: String.t(), code: String.t(), country_id: String.t()}

Check t/0 type for more information about the keys.

t()

t() :: %StrawHat.Map.State{
  __meta__: term(),
  cities: [StrawHat.Map.City.t()] | Ecto.Association.NotLoaded.t(),
  code: String.t(),
  counties: [StrawHat.Map.County.t()] | Ecto.Association.NotLoaded.t(),
  country: State.t() | Ecto.Association.NotLoaded.t(),
  country_id: String.t(),
  id: term(),
  name: String.t()
}

name: Name of the state.
code: Code of the state.
country: StrawHat.Map.Country.t/0 associated with the current state.
country_id: id of StrawHat.Map.Country.t/0 associated with the state.
counties: List of StrawHat.Map.County.t/0 associated with the current state.
cities: List of StrawHat.Map.City.t/0 associated with the current state.

Link to this section Functions

changeset(state, state_attrs)

changeset(t(), state_attrs()) :: Ecto.Changeset.t()

Validates the attributes and return a Ecto.Changeset for the current State.