Ecto.UUID (Ecto v3.7.1) View Source

An Ecto type for UUID strings.

Link to this section Summary

Types

raw()

A raw binary representation of a UUID.

t()

A hex-encoded UUID string.

Functions

bingenerate()

Generates a random, version 4 UUID in the binary format.

cast(raw_uuid)

Casts to a UUID.

cast!(value)

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

dump(arg1)

Converts a string representing a UUID into a raw binary.

dump!(value)

Same as dump/1 but raises Ecto.ArgumentError on invalid arguments.

embed_as(_)

Callback implementation for Ecto.Type.embed_as/1.

equal?(term1, term2)

Callback implementation for Ecto.Type.equal?/2.

generate()

Generates a random, version 4 UUID.

load(raw_uuid)

Converts a binary UUID into a string.

load!(value)

Same as load/1 but raises Ecto.ArgumentError on invalid arguments.

Link to this section Types

raw()

Specs

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

A raw binary representation of a UUID.

t()

Specs

t() :: <<_::288>>

A hex-encoded UUID string.

Link to this section Functions

bingenerate()

Specs

bingenerate() :: raw()

Generates a random, version 4 UUID in the binary format.

cast(raw_uuid)

Specs

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

Casts to a UUID.

cast!(value)

Specs

cast!(t() | raw() | any()) :: t() | no_return()

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

dump(arg1)

Specs

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

Converts a string representing a UUID into a raw binary.

dump!(value)

Specs

dump!(t() | any()) :: raw() | no_return()

Same as dump/1 but raises Ecto.ArgumentError on invalid arguments.

embed_as(_)

Callback implementation for Ecto.Type.embed_as/1.

equal?(term1, term2)

Callback implementation for Ecto.Type.equal?/2.

generate()

Specs

generate() :: t()

Generates a random, version 4 UUID.

load(raw_uuid)

Specs

load(raw() | any()) :: {:ok, t()} | :error | no_return()

Converts a binary UUID into a string.

load!(value)

Specs

load!(raw() | any()) :: t() | no_return()

Same as load/1 but raises Ecto.ArgumentError on invalid arguments.