View Source Teiserver.Settings.UserSettingLib (Teiserver v0.0.4)
Library of user_setting related functions.
Summary
Functions
Returns an %Ecto.Changeset{}
for tracking user_setting changes.
Creates a user_setting.
Deletes a user_setting.
Gets a single user_setting.
Gets a single user_setting.
Returns the list of user_settings.
Updates a user_setting.
Functions
@spec change_user_setting(Teiserver.Settings.UserSetting.t(), map()) :: Ecto.Changeset.t()
Returns an %Ecto.Changeset{}
for tracking user_setting changes.
Examples
iex> change_user_setting(user_setting)
%Ecto.Changeset{data: %UserSetting{}}
@spec create_user_setting(map()) :: {:ok, Teiserver.Settings.UserSetting.t()} | {:error, Ecto.Changeset.t()}
Creates a user_setting.
Examples
iex> create_user_setting(%{field: value})
{:ok, %UserSetting{}}
iex> create_user_setting(%{field: bad_value})
{:error, %Ecto.Changeset{}}
@spec delete_user_setting(Teiserver.Settings.UserSetting.t()) :: {:ok, Teiserver.Settings.UserSetting.t()} | {:error, Ecto.Changeset.t()}
Deletes a user_setting.
Examples
iex> delete_user_setting(user_setting)
{:ok, %UserSetting{}}
iex> delete_user_setting(user_setting)
{:error, %Ecto.Changeset{}}
@spec get_user_setting(non_neg_integer(), list()) :: Teiserver.Settings.UserSetting.t() | nil
Gets a single user_setting.
Returns nil if the UserSetting does not exist.
Examples
iex> get_user_setting(123)
%UserSetting{}
iex> get_user_setting(456)
nil
Gets a single user_setting.
Raises Ecto.NoResultsError
if the UserSetting does not exist.
Examples
iex> get_user_setting!(123)
%UserSetting{}
iex> get_user_setting!(456)
** (Ecto.NoResultsError)
@spec list_user_settings(Teiserver.query_args()) :: list()
Returns the list of user_settings.
Examples
iex> list_user_settings()
[%UserSetting{}, ...]
@spec update_user_setting(Teiserver.Settings.UserSetting.t(), map()) :: {:ok, Teiserver.Settings.UserSetting.t()} | {:error, Ecto.Changeset.t()}
Updates a user_setting.
Examples
iex> update_user_setting(user_setting, %{field: new_value})
{:ok, %UserSetting{}}
iex> update_user_setting(user_setting, %{field: bad_value})
{:error, %Ecto.Changeset{}}