Elixir
Elixir v1.8.2 API Reference
Modules
- Access
-
Key-based access to data structures.
- Agent
-
Agents are a simple abstraction around state.
- Application
-
A module for working with applications and defining application callbacks.
- Atom
-
Convenience functions for working with atoms.
- Base
-
This module provides data encoding and decoding functions according to RFC 4648.
- Behaviour deprecated
-
Mechanism for handling behaviours.
- Bitwise
-
A set of macros that perform calculations on bits.
- Calendar
-
This module defines the responsibilities for working with calendars, dates, times and datetimes in Elixir.
- Calendar.ISO
-
A calendar implementation that follows to ISO 8601.
- Calendar.TimeZoneDatabase
-
This module defines a behaviour for providing time zone data.
- Calendar.UTCOnlyTimeZoneDatabase
-
Built-in time zone database that works only in Etc/UTC.
- Code
-
Utilities for managing code compilation, code evaluation, and code loading.
- Collectable
-
A protocol to traverse data structures.
- Date
-
A Date struct and functions.
- Date.Range
-
Returns an inclusive range between dates.
- DateTime
-
A datetime implementation with a time zone.
- Dict deprecated
-
Generic API for dictionaries.
- DynamicSupervisor
-
A supervisor that starts children dynamically.
- Enum
-
Provides a set of algorithms to work with enumerables.
- Enumerable
- Exception
-
Functions to format throw/catch/exit and exceptions.
- File
-
This module contains functions to manipulate files.
- File.Stat
-
A struct that holds file information.
- File.Stream
-
Defines a
File.Stream
struct returned byFile.stream!/3
. - Float
-
Functions for working with floating-point numbers.
- Function
-
A set of functions for working with functions.
- GenEvent deprecated
-
A event manager with event handlers behaviour.
- GenServer
-
A behaviour module for implementing the server of a client-server relation.
- HashDict deprecated
-
Tuple-based HashDict implementation.
- HashSet deprecated
-
Tuple-based HashSet implementation.
- IO
-
Functions handling input/output (IO).
- IO.ANSI
-
Functionality to render ANSI escape sequences.
- IO.Stream
-
Defines an
IO.Stream
struct returned byIO.stream/2
andIO.binstream/2
. - Inspect
-
The
Inspect
protocol converts an Elixir data structure into an algebra document. - Inspect.Algebra
-
A set of functions for creating and manipulating algebra documents.
- Inspect.Opts
-
Defines the options used by the
Inspect
protocol. - Integer
-
Functions for working with integers.
- Kernel
-
Kernel
is Elixir's default environment. - Kernel.ParallelCompiler
-
A module responsible for compiling and requiring files in parallel.
- Kernel.SpecialForms
-
Special forms are the basic building blocks of Elixir, and therefore cannot be overridden by the developer.
- Keyword
-
A set of functions for working with keywords.
- List
-
Functions that work on (linked) lists.
- List.Chars
-
The
List.Chars
protocol is responsible for converting a structure to a charlist (only if applicable). - Macro
-
Conveniences for working with macros.
- Macro.Env
-
A struct that holds compile time environment information.
- Map
-
A set of functions for working with maps.
- MapSet
-
Functions that work on sets.
- Module
-
Provides functions to deal with modules during compilation time.
- NaiveDateTime
-
A NaiveDateTime struct (without a time zone) and functions.
- Node
-
Functions related to VM nodes.
- OptionParser
-
Functions for parsing command line options.
- Path
-
This module provides conveniences for manipulating or retrieving file system paths.
- Port
-
Functions for interacting with the external world through ports.
- Process
-
Conveniences for working with processes and the process dictionary.
- Protocol
-
Functions for working with protocols.
- Range
-
Defines a range.
- Record
-
Module to work with, define, and import records.
- Regex
-
Provides regular expressions for Elixir.
- Registry
-
A local, decentralized and scalable key-value process storage.
- Set deprecated
-
Generic API for sets.
- Stream
-
Functions for creating and composing streams.
- String
-
A String in Elixir is a UTF-8 encoded binary.
- String.Chars
-
The
String.Chars
protocol is responsible for converting a structure to a binary (only if applicable). - StringIO
-
Controls an IO device process that wraps a string.
- Supervisor
-
A behaviour module for implementing supervisors.
- Supervisor.Spec deprecated
-
Outdated functions for building child specifications.
- System
-
The
System
module provides functions that interact directly with the VM or the host system. - Task
-
Conveniences for spawning and awaiting tasks.
- Task.Supervisor
-
A task supervisor.
- Time
-
A Time struct and functions.
- Tuple
-
Functions for working with tuples.
- URI
-
Utilities for working with URIs.
- Version
-
Functions for parsing and matching versions against requirements.
Exceptions
- ArgumentError
- ArithmeticError
- BadArityError
- BadBooleanError
- BadFunctionError
- BadMapError
- BadStructError
- CaseClauseError
- Code.LoadError
- CompileError
- CondClauseError
- Enum.EmptyError
- Enum.OutOfBoundsError
- ErlangError
- File.CopyError
- File.Error
- File.LinkError
- FunctionClauseError
- IO.StreamError
- Inspect.Error
-
Raised when a struct cannot be inspected.
- KeyError
- MatchError
- OptionParser.ParseError
- Protocol.UndefinedError
- Regex.CompileError
- RuntimeError
- SyntaxError
- SystemLimitError
- TokenMissingError
- TryClauseError
- UndefinedFunctionError
- UnicodeConversionError
- Version.InvalidRequirementError
- Version.InvalidVersionError
- WithClauseError
© 2012 Plataformatec
Licensed under the Apache License, Version 2.0.
https://hexdocs.pm/elixir/1.8.2/api-reference.html