View Source MaatFeather.Users (maat_feather v0.1.0)

The Users context.

Link to this section Summary

Functions

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

Creates a user.

Deletes a user.

Gets a single user.

Gets a single user by any field.

Returns the list of users.

Updates a user.

Link to this section Functions

Link to this function

change_user(user, attrs \\ %{})

View Source

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

examples

Examples

iex> change_user(user)
%Ecto.Changeset{data: %User{}}
Link to this function

create_user(attrs \\ %{})

View Source

Creates a user.

examples

Examples

iex> create_user(%{field: value})
{:ok, %User{}}

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

Deletes a user.

examples

Examples

iex> delete_user(user)
{:ok, %User{}}

iex> delete_user(user)
{:error, %Ecto.Changeset{}}

Gets a single user.

Raises Ecto.NoResultsError if the User does not exist.

examples

Examples

iex> get_user!(123)
%User{}

iex> get_user!(456)
** (Ecto.NoResultsError)

Gets a single user by any field.

Raises Ecto.NoResultsError if the User does not exist.

examples

Examples

iex> get_user_by!(email: "valid@mail.com")
%User{}

iex> get_user_by!(email: "invalid@mail.com")
nil

Returns the list of users.

examples

Examples

iex> list_users()
[%User{}, ...]
Link to this function

update_user(user, attrs)

View Source

Updates a user.

examples

Examples

iex> update_user(user, %{field: new_value})
{:ok, %User{}}

iex> update_user(user, %{field: bad_value})
{:error, %Ecto.Changeset{}}