String.Chars — Elixir v1.16.3

Search documentation of Elixir

# View Source String.Chars protocol (Elixir v1.16.3)

The `String.Chars` protocol is responsible for converting a structure to a binary (only if applicable).

The only function required to be implemented is `to_string/1`, which does the conversion.

The `to_string/1` function automatically imported by `Kernel` invokes this protocol. String interpolation also invokes `to_string/1` in its arguments. For example, `"foo#{bar}"` is the same as `"foo" <> to_string(bar)`.

# Summary

## Types

t()

All the types that implement this protocol.

## Functions

to_string(term)

Converts `term` to a string.

# Types

Link to this type

# t()

View Source

    @type t() :: term()

All the types that implement this protocol.

# Functions

Link to this function

# to_string(term)

View Source

    @spec to_string(t()) :: String.t()

Converts `term` to a string.