# `Ecto.UUID`
[🔗](https://github.com/elixir-ecto/ecto/blob/v3.13.6/lib/ecto/uuid.ex#L1)

An Ecto type for UUID strings.

# `raw`

```elixir
@type raw() :: <<_::128>>
```

A raw binary representation of a UUID.

# `t`

```elixir
@type t() :: <<_::288>>
```

A hex-encoded UUID string.

# `bingenerate`

```elixir
@spec bingenerate() :: raw()
```

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

# `cast`

```elixir
@spec cast(t() | raw() | any()) :: {:ok, t()} | :error
```

Casts either a string in the canonical, human-readable UUID format or a
16-byte binary to a UUID in its canonical, human-readable UUID format.

If `uuid` is neither of these, `:error` will be returned.

Since both binaries and strings are represented as binaries, this means some
strings you may not expect are actually also valid UUIDs in their binary form
and so will be casted into their string form.

If you need further-restricted behavior or validation, you should define your
own custom `Ecto.Type`. There is also `Ecto.UUID.load/1` if you only want to
process `raw` UUIDs, which may be a more suitable reverse operation to
`Ecto.UUID.dump/1`.

## Examples

    iex> Ecto.UUID.cast(<<0x60, 0x1D, 0x74, 0xE4, 0xA8, 0xD3, 0x4B, 0x6E,
    ...>                  0x83, 0x65, 0xED, 0xDB, 0x4C, 0x89, 0x33, 0x27>>)
    {:ok, "601d74e4-a8d3-4b6e-8365-eddb4c893327"}

    iex> Ecto.UUID.cast("601d74e4-a8d3-4b6e-8365-eddb4c893327")
    {:ok, "601d74e4-a8d3-4b6e-8365-eddb4c893327"}

    iex> Ecto.UUID.cast("warehouse worker")
    {:ok, "77617265-686f-7573-6520-776f726b6572"}

# `cast!`

```elixir
@spec cast!(t() | raw() | any()) :: t()
```

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

# `dump`

```elixir
@spec dump(uuid_string :: t() | any()) :: {:ok, raw()} | :error
```

Converts a string representing a UUID into a raw binary.

# `dump!`

```elixir
@spec dump!(t() | any()) :: raw()
```

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

# `embed_as`

# `equal?`

# `generate`

```elixir
@spec generate() :: t()
```

Generates a random, version 4 UUID.

# `load`

```elixir
@spec load(raw() | any()) :: {:ok, t()} | :error
```

Converts a binary UUID into a string.

# `load!`

```elixir
@spec load!(raw() | any()) :: t()
```

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

---

*Consult [api-reference.md](api-reference.md) for complete listing*