4. Modules and Functions | Elixir Cookbook

Sign In Start Free Trial

Book Overview & Buying
Table Of Contents
Feedback & Rating

Elixir Cookbook

By : Paulo Pereira

4.5 (2)

Elixir Cookbook

4.5 (2)

By: Paulo Pereira

Overview of this book

This book is intended for users with some knowledge of the Elixir language syntax and basic data types/structures. Although this is a cookbook and no sequential reading is required, the book’s structure will allow less advanced users who follow it to be gradually exposed to some of Elixir’s features and concepts specific to functional programming. To get the most out of this book, you need to be well versed with Erlang.

Preface

Preface

What this book covers

What you need for this book

Who this book is for

Sections

Conventions

Reader feedback

Customer support

Free Chapter

1. Command Line

1. Command Line

Introduction

Using the terminal to prototype and test ideas

Loading and compiling modules

Getting help and accessing documentation within IEx

Using Erlang from Elixir

Inspecting your system in IEx

Inspecting your system with Observer

Creating a simple application

Managing dependencies

Generating a supervised application

Generating umbrella applications

Managing application configuration

Creating custom Mix tasks

2. Data Types and Structures

2. Data Types and Structures

Understanding immutability

Adding and subtracting lists

Combining tuples into a list

Creating and manipulating keyword lists

Using pattern matching

Pattern matching an HTTPoison response

Creating a key/value store with a map

Mapping and reducing enumerables

Generating lazy (even infinite) sequences

Streaming a file as a resource

3. Strings and Binaries

3. Strings and Binaries

Introduction

Joining strings

Splitting strings

Replacing string codepoints with patterns

Slicing strings with ranges

Using regular expressions

Combining operations with the |> operator

Creating a word list

Determining the word frequency in a text

Reading and writing metadata from MP3 files

4. Modules and Functions

4. Modules and Functions

Introduction

Namespacing modules

Using module attributes as constants

Enforcing behaviors

Documenting modules

Using module directives

Using a module in the scripted mode

Defining functions with default arguments

Using guard clauses and pattern matching in function definitions

5. Processes and Nodes

5. Processes and Nodes

Introduction

Sending messages between processes

Making code run on all available CPUs

Using tasks to perform multiple concurrent computations

Creating a stateful server process (messages with counters)

Using agents as an abstraction around states

Using an ETS table to share the state

Creating named nodes

Connecting nodes

Executing code in a different node

6. OTP – Open Telecom Platform

6. OTP – Open Telecom Platform

Introduction

Implementing a GenServer

Expanding our server

Creating a supervisor

Using Observer to inspect supervisors and processes

Handling errors and managing exceptions

Packaging and releasing an OTP application

Deploying applications and updating a running system

7. Cowboy and Phoenix

7. Cowboy and Phoenix

Introduction

Setting up Cowboy

Serving static files

Implementing a websocket handler

Creating a Phoenix application

Defining routes

Creating a controller

Creating views and templates

Implementing topics

Protecting the Phoenix app with SSL

8. Interactions

8. Interactions

Introduction

Using Redis and Postgres

Using OS commands from within Elixir

Getting Twitter data

A. Installation and Further Reading

A. Installation and Further Reading

Installing Elixir

Installing PostgreSQL

Installing Redis

Some useful links

Index

Index

Customer Reviews

4.5 (2)

5 star

50%

4 star

50%

3 star

0

2 star

0

1 star

0

Documenting modules

In this recipe, we will be using the @moduledoc and @doc reserved module attributes to add documentation to the modules we defined in the previous recipe, Enforcing behaviors.

Getting ready

Open the randomizer.ex and my_module.ex files created in the Enforcing behaviors recipe inside your preferred code editor.

How to do it…

To add documentation to our modules, follow these steps:

We will start by adding module documentation to the randomizer.ex file. Add the following code below the use Behavior line:
```
@moduledoc """
  This module specifies the interface for a randomizer behaviour by using the defcallback macro.
"""
```
Add the following module documentation to the my_module.ex file below the @behaviour Randomizer line:
```
@moduledoc """
  This is a custom module to demo the implementation of behaviours.
"""
```
To document the randomize function inside my_module.ex, insert the following code right above the function definition:
```
@doc """
The randomize callback defines the randomize function...
```

Search

Your notes and bookmarks