Ecto.UUID (Ecto v3.7.1) View Source

An Ecto type for UUID strings.

Link to this section Summary

Types

A raw binary representation of a UUID.

t()

A hex-encoded UUID string.

Functions

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

Casts to a UUID.

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

Converts a string representing a UUID into a raw binary.

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

Callback implementation for Ecto.Type.embed_as/1.

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

Generates a random, version 4 UUID.

Converts a binary UUID into a string.

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

Link to this section Types

Specs

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

A raw binary representation of a UUID.

Specs

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

A hex-encoded UUID string.

Link to this section Functions

Specs

bingenerate() :: raw()

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

Specs

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

Casts to a UUID.

Specs

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

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

Specs

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

Converts a string representing a UUID into a raw binary.

Specs

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

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

Callback implementation for Ecto.Type.embed_as/1.

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

Specs

generate() :: t()

Generates a random, version 4 UUID.

Specs

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

Converts a binary UUID into a string.

Specs

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

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