# Elixir v1.10.3 Inspect.Opts View Source

Defines the options used by the `Inspect` protocol.

The following fields are available:

- `:base` - prints integers as `:binary`, `:octal`, `:decimal`, or `:hex`, defaults to `:decimal`. When inspecting binaries any `:base` other than `:decimal` implies `binaries: :as_binaries`.

- `:binaries` - when `:as_binaries` all binaries will be printed in bit syntax.

  When `:as_strings` all binaries will be printed as strings, non-printable bytes will be escaped.

  When the default `:infer`, the binary will be printed as a string if it is printable, otherwise in bit syntax. See `String.printable?/1` to learn when a string is printable.

- `:charlists` - when `:as_charlists` all lists will be printed as charlists, non-printable elements will be escaped.

  When `:as_lists` all lists will be printed as lists.

  When the default `:infer`, the list will be printed as a charlist if it is printable, otherwise as list. See `List.ascii_printable?/1` to learn when a charlist is printable.

- `:custom_options` (since v1.9.0) - a keyword list storing custom user-defined options. Useful when implementing the `Inspect` protocol for nested structs to pass the custom options through.

- `:inspect_fun` (since v1.9.0) - a function to build algebra documents, defaults to `Inspect.inspect/2`.

- `:limit` - limits the number of items that are inspected for tuples, bitstrings, maps, lists and any other collection of items. It does not apply to printable strings nor printable charlists and defaults to 50. If you don't want to limit the number of items to a particular number, use `:infinity`.

- `:pretty` - if set to `true` enables pretty printing, defaults to `false`.

- `:printable_limit` - limits the number of characters that are inspected on printable strings and printable charlists. You can use `String.printable?/1` and `List.ascii_printable?/1` to check if a given string or charlist is printable. Defaults to 4096. If you don't want to limit the number of characters to a particular number, use `:infinity`.

- `:safe` - when `false`, failures while inspecting structs will be raised as errors instead of being wrapped in the `Inspect.Error` exception. This is useful when debugging failures and crashes for custom inspect implementations.

- `:structs` - when `false`, structs are not formatted by the inspect protocol, they are instead printed as maps, defaults to `true`.

- `:syntax_colors` - when set to a keyword list of colors the output is colorized. The keys are types and the values are the colors to use for each type (for example, `[number: :red, atom: :blue]`). Types can include `:atom`, `:binary`, `:boolean`, `:list`, `:map`, `:number`, `:regex`, `:string`, and `:tuple`. Custom data types may provide their own options. Colors can be any `t:IO.ANSI.ansidata/0` as accepted by `IO.ANSI.format/1`.

- `:width` - defaults to 80 characters, used when pretty is `true` or when printing to IO devices. Set to 0 to force each item to be printed on its own line. If you don't want to limit the number of items to a particular number, use `:infinity`.

# Link to this section Summary

## Types

color_key()
t()

# Link to this section Types

Link to this type

# color_key()

View Source

## Specs

    color_key() :: atom()

Link to this type

# t()

View Source

## Specs

    t() :: %Inspect.Opts{
      base: :decimal | :binary | :hex | :octal,
      binaries: :infer | :as_binaries | :as_strings,
      char_lists: :infer | :as_lists | :as_char_lists,
      charlists: :infer | :as_lists | :as_charlists,
      custom_options: keyword(),
      inspect_fun: (any(), t() -> Inspect.Algebra.t()),
      limit: pos_integer() | :infinity,
      pretty: boolean(),
      printable_limit: pos_integer() | :infinity,
      safe: boolean(),
      structs: boolean(),
      syntax_colors: [{color_key(), IO.ANSI.ansidata()}],
      width: pos_integer() | :infinity
    }