# `Mojibake.Plane`
[🔗](https://github.com/zaerl/mojibake/blob/main/src/elixir/lib/mojibake/plane.ex#L5)

Unicode planes: the 17 ranges of 65,536 codepoints, numbered 0 to 16.

`Mojibake.Char.plane/1` returns the plane of a codepoint.

# `t`

```elixir
@type t() :: 0..16
```

A plane number, 0 to 16.

# `abbreviation`

```elixir
@spec abbreviation(t()) :: String.t() | nil
```

The abbreviation of `plane`, such as `"BMP"`, or `nil` for the unassigned planes 4 to 13.

## Examples

    iex> Mojibake.Plane.abbreviation(1)
    "SMP"

    iex> Mojibake.Plane.abbreviation(15)
    "PUA-A"

# `name`

```elixir
@spec name(t()) :: String.t() | nil
```

The name of `plane`, or `nil` for the unassigned planes 4 to 13.

## Examples

    iex> Mojibake.Plane.name(0)
    "Basic Multilingual Plane"

    iex> Mojibake.Plane.name(5)
    nil

# `range`

```elixir
@spec range(t()) :: Range.t()
```

The codepoints of `plane`.

## Examples

    iex> Mojibake.Plane.range(1)
    65536..131071

---

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