View Source Teiserver.Settings.ServerSettingLib (Teiserver v0.0.4)

Library of server_setting related functions.

Summary

Functions

Returns an %Ecto.Changeset{} for tracking server_setting changes.

Creates a server_setting.

Deletes a server_setting.

Gets a single server_setting.

Gets a single server_setting.

Returns the list of server_settings.

Functions

Link to this function

change_server_setting(server_setting, attrs \\ %{})

View Source
@spec change_server_setting(Teiserver.Settings.ServerSetting.t(), map()) ::
  Ecto.Changeset.t()

Returns an %Ecto.Changeset{} for tracking server_setting changes.

Examples

iex> change_server_setting(server_setting)
%Ecto.Changeset{data: %ServerSetting{}}
Link to this function

create_server_setting(attrs \\ %{})

View Source
@spec create_server_setting(map()) ::
  {:ok, Teiserver.Settings.ServerSetting.t()} | {:error, Ecto.Changeset.t()}

Creates a server_setting.

Examples

iex> create_server_setting(%{field: value})
{:ok, %ServerSetting{}}

iex> create_server_setting(%{field: bad_value})
{:error, %Ecto.Changeset{}}
Link to this function

delete_server_setting(server_setting)

View Source
@spec delete_server_setting(Teiserver.Settings.ServerSetting.t()) ::
  {:ok, Teiserver.Settings.ServerSetting.t()} | {:error, Ecto.Changeset.t()}

Deletes a server_setting.

Examples

iex> delete_server_setting(server_setting)
{:ok, %ServerSetting{}}

iex> delete_server_setting(server_setting)
{:error, %Ecto.Changeset{}}
Link to this function

get_server_setting(key, query_args \\ [])

View Source
@spec get_server_setting(non_neg_integer(), list()) ::
  Teiserver.Settings.ServerSetting.t() | nil

Gets a single server_setting.

Returns nil if the ServerSetting does not exist.

Examples

iex> get_server_setting(123)
%ServerSetting{}

iex> get_server_setting(456)
nil
Link to this function

get_server_setting!(key, query_args \\ [])

View Source

Gets a single server_setting.

Raises Ecto.NoResultsError if the ServerSetting does not exist.

Examples

iex> get_server_setting!(123)
%ServerSetting{}

iex> get_server_setting!(456)
** (Ecto.NoResultsError)
Link to this function

list_server_settings(query_args \\ [])

View Source
@spec list_server_settings(list()) :: list()

Returns the list of server_settings.

Examples

iex> list_server_settings()
[%ServerSetting{}, ...]
Link to this function

update_server_setting(server_setting, attrs)

View Source
@spec update_server_setting(Teiserver.Settings.ServerSetting.t(), map()) ::
  {:ok, Teiserver.Settings.ServerSetting.t()} | {:error, Ecto.Changeset.t()}

Updates a server_setting.

Examples

iex> update_server_setting(server_setting, %{field: new_value})
{:ok, %ServerSetting{}}

iex> update_server_setting(server_setting, %{field: bad_value})
{:error, %Ecto.Changeset{}}