Ecto v3.1.1 Ecto.UUID View Source

An Ecto type for UUIDs strings.

Link to this section Summary

Types

A raw binary representation of a UUID.

t()

A hex-encoded UUID string.

Functions

Generates a version 4 (random) UUID in the binary format.

Casts to UUID.

Same as cast/1 but raises Ecto.CastError on invalid arguments.

Converts a string representing a UUID into a binary.

Generates a version 4 (random) UUID.

Converts a binary UUID into a string.

The Ecto type.

Link to this section Types

Link to this type

raw() View Source
raw() :: <<_::128>>

A raw binary representation of a UUID.

A hex-encoded UUID string.

Link to this section Functions

Link to this function

bingenerate() View Source
bingenerate() :: raw()

Generates a version 4 (random) UUID in the binary format.

Link to this function

cast(binary) View Source
cast(t() | raw() | any()) :: {:ok, t()} | :error

Casts to UUID.

Link to this function

cast!(value) View Source
cast!(t() | raw() | any()) :: t()

Same as cast/1 but raises Ecto.CastError on invalid arguments.

Link to this function

dump(arg1) View Source
dump(t() | any()) :: {:ok, raw()} | :error

Converts a string representing a UUID into a binary.

Link to this function

generate() View Source
generate() :: t()

Generates a version 4 (random) UUID.

Link to this function

load(uuid) View Source
load(raw() | any()) :: {:ok, t()} | :error

Converts a binary UUID into a string.

The Ecto type.