StrawHat.Map v1.0.0 StrawHat.Map.City View Source

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

Link to this section Summary

Types

city_attrs()

Check t/0 type for more information about the keys

t()

name: Name of the city.
capital: Defines the city as capital of the country.
state: StrawHat.Map.State.t/0 associated with the city.
state_id: id of StrawHat.Map.State.t/0 associated with the city.
county: StrawHat.Map.County.t/0 associated with the city.
county_id: id of StrawHat.Map.County.t/0 associated with the city.
addresses: List of StrawHat.Map.Address.t/0 associated with the city

Functions

changeset(city, city_attrs)

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

Link to this section Types

city_attrs()

city_attrs() :: %{
  name: String.t(),
  capital: boolean(),
  state_id: Integer.t(),
  county_id: Integer.t()
}

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

t()

t() :: %StrawHat.Map.City{
  __meta__: term(),
  addresses: [StrawHat.Map.Address.t()],
  capital: boolean(),
  county: StrawHat.Map.County.t() | Ecto.Association.NotLoaded.t(),
  county_id: Integer.t(),
  id: term(),
  name: String.t(),
  state: StrawHat.Map.State.t() | Ecto.Association.NotLoaded.t(),
  state_id: Integer.t()
}

name: Name of the city.
capital: Defines the city as capital of the country.
state: StrawHat.Map.State.t/0 associated with the city.
state_id: id of StrawHat.Map.State.t/0 associated with the city.
county: StrawHat.Map.County.t/0 associated with the city.
county_id: id of StrawHat.Map.County.t/0 associated with the city.
addresses: List of StrawHat.Map.Address.t/0 associated with the city.

Link to this section Functions

changeset(city, city_attrs)

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

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