On this page
Ecto.UUID
An Ecto type for UUID strings.
Summary
Types
Functions
- bingenerate()
-
Generates a random, version 4 UUID in the binary format.
- cast!(value)
-
Same as
cast/1
but raisesEcto.CastError
on invalid arguments. - cast(raw_uuid)
-
Casts to a UUID.
- dump!(value)
-
Same as
dump/1
but raisesEcto.ArgumentError
on invalid arguments. - dump(arg1)
-
Converts a string representing a UUID into a raw binary.
- 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!(value)
-
Same as
load/1
but raisesEcto.ArgumentError
on invalid arguments. - load(raw_uuid)
-
Converts a binary UUID into a string.
Types
Functions
bingenerate()Source
@spec bingenerate() :: raw()
Generates a random, version 4 UUID in the binary format.
cast!(value)Source
@spec cast!(t() | raw() | any()) :: t()
Same as cast/1
but raises Ecto.CastError
on invalid arguments.
cast(raw_uuid)Source
@spec cast(t() | raw() | any()) :: {:ok, t()} | :error
Casts to a UUID.
dump!(value)Source
@spec dump!(t() | any()) :: raw()
Same as dump/1
but raises Ecto.ArgumentError
on invalid arguments.
dump(arg1)Source
@spec dump(t() | any()) :: {:ok, raw()} | :error
Converts a string representing a UUID into a raw binary.
embed_as(_)Source
Callback implementation for Ecto.Type.embed_as/1
.
equal?(term1, term2)Source
Callback implementation for Ecto.Type.equal?/2
.
generate()Source
@spec generate() :: t()
Generates a random, version 4 UUID.
load!(value)Source
@spec load!(raw() | any()) :: t()
Same as load/1
but raises Ecto.ArgumentError
on invalid arguments.
load(raw_uuid)Source
@spec load(raw() | any()) :: {:ok, t()} | :error
Converts a binary UUID into a string.
© 2013 Plataformatec
© 2020 Dashbit
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/ecto/Ecto.UUID.html