Elixir v1.7.3 API Reference


Key-based access to data structures

Agents are a simple abstraction around state

A module for working with applications and defining application callbacks

Convenience functions for working with atoms

This module provides data encoding and decoding functions according to RFC 4648

Behaviour deprecated

Mechanism for handling behaviours

A set of macros that perform calculations on bits

This module defines the responsibilities for working with calendars, dates, times and datetimes in Elixir

A calendar implementation that follows to ISO 8601

Utilities for managing code compilation, code evaluation, and code loading

A protocol to traverse data structures

A Date struct and functions

Returns an inclusive range between dates

A datetime implementation with a time zone

Dict deprecated

Generic API for dictionaries

A supervisor that starts children dynamically

Provides a set of algorithms to work with enumerables

Enumerable protocol used by Enum and Stream modules

Functions to format throw/catch/exit and exceptions

This module contains functions to manipulate files

A struct that holds file information

Defines a File.Stream struct returned by File.stream!/3

Functions for working with floating-point numbers

A set of functions for working with functions

GenEvent deprecated

A event manager with event handlers behaviour

A behaviour module for implementing the server of a client-server relation

HashDict deprecated

Tuple-based HashDict implementation

HashSet deprecated

Tuple-based HashSet implementation


Functions handling input/output (IO)

Functionality to render ANSI escape sequences

Defines an IO.Stream struct returned by IO.stream/2 and IO.binstream/2

The Inspect protocol converts an Elixir data structure into an algebra document

A set of functions for creating and manipulating algebra documents

Defines the Inspect.Opts used by the Inspect protocol

Functions for working with integers

Kernel is Elixir’s default environment

A module responsible for compiling and requiring files in parallel

Special forms are the basic building blocks of Elixir, and therefore cannot be overridden by the developer

A set of functions for working with keywords

Functions that work on (linked) lists

The List.Chars protocol is responsible for converting a structure to a charlist (only if applicable)

Conveniences for working with macros

A struct that holds compile time environment information


A set of functions for working with maps

Functions that work on sets

Provides functions to deal with modules during compilation time

A NaiveDateTime struct (without a time zone) and functions

Functions related to VM nodes

This module contains functions to parse command line options

This module provides conveniences for manipulating or retrieving file system paths

Functions for interacting with the external world through ports

Conveniences for working with processes and the process dictionary

Functions for working with protocols

Defines a range

Module to work with, define, and import records

Provides regular expressions for Elixir

A local, decentralized and scalable key-value process storage

Set deprecated

Generic API for sets

Functions for creating and composing streams

A String in Elixir is a UTF-8 encoded binary

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

Controls an IO device process that wraps a string

A behaviour module for implementing supervisors

Supervisor.Spec deprecated

Outdated functions for building child specifications

The System module provides functions that interact directly with the VM or the host system

Conveniences for spawning and awaiting tasks

A task supervisor

A Time struct and functions

Functions for working with tuples


Utilities for working with URIs

Functions for parsing and matching versions against requirements