Modules Exceptions Protocols

Agent
- Introduction
- Types
- Functions
  - cast/2
  - cast/4
  - get/3
  - get/5
  - get_and_update/3
  - get_and_update/5
  - start/2
  - start/4
  - start_link/2
  - start_link/4
  - stop/2
  - update/3
  - update/5
Application
- Introduction
- Types
- Functions
Atom
- Functions
  - to_char_list/1
  - to_string/1
Base
- Introduction
- Functions
Behaviour
- Introduction
- Macros
Bitwise
- Introduction
- Macros
Code
- Introduction
- Functions
Dict
- Introduction
- Types
- Functions
  - delete/2
  - drop/2
  - equal?/2
  - fetch/2
  - fetch!/2
  - get/2
  - get/3
  - has_key?/2
  - keys/1
  - merge/2
  - merge/3
  - new/0
  - pop/2
  - pop/3
  - put/3
  - put_new/3
  - size/1
  - split/2
  - take/2
  - to_list/1
  - update/4
  - update!/3
  - values/1
  - delete/2
  - drop/2
  - equal?/2
  - fetch/2
  - fetch!/2
  - get/3
  - has_key?/2
  - keys/1
  - merge/3
  - pop/3
  - put/3
  - put_new/3
  - size/1
  - split/2
  - take/2
  - to_list/1
  - update/4
  - update!/3
  - values/1
- Callbacks
Enum
- Introduction
- Types
- Functions
  - all?/2
  - any?/2
  - at/3
  - chunk/2
  - chunk/4
  - chunk_by/2
  - concat/1
  - concat/2
  - count/1
  - count/2
  - drop/2
  - drop_while/2
  - each/2
  - empty?/1
  - fetch/2
  - fetch!/2
  - filter/2
  - filter_map/3
  - find/3
  - find_index/2
  - find_value/3
  - flat_map/2
  - flat_map_reduce/3
  - group_by/3
  - intersperse/2
  - into/2
  - into/3
  - join/2
  - map/2
  - map_join/3
  - map_reduce/3
  - max/1
  - max_by/2
  - member?/2
  - min/1
  - min_by/2
  - partition/2
  - reduce/2
  - reduce/3
  - reject/2
  - reverse/1
  - reverse/2
  - scan/2
  - scan/3
  - shuffle/1
  - slice/2
  - slice/3
  - sort/1
  - sort/2
  - sort_by/3
  - split/2
  - split_while/2
  - sum/1
  - take/2
  - take_every/2
  - take_while/2
  - to_list/1
  - uniq/2
  - with_index/1
  - zip/2
Exception
- Introduction
- Types
- Functions
File
- Introduction
- Types
- Functions
  - cd/1
  - cd!/1
  - cd!/2
  - chgrp/2
  - chgrp!/2
  - chmod/2
  - chmod!/2
  - chown/2
  - chown!/2
  - close/1
  - copy/3
  - copy!/3
  - cp/3
  - cp!/3
  - cp_r/3
  - cp_r!/3
  - cwd/0
  - cwd!/0
  - dir?/1
  - exists?/1
  - ln_s/2
  - ls/1
  - ls!/1
  - mkdir/1
  - mkdir!/1
  - mkdir_p/1
  - mkdir_p!/1
  - open/2
  - open/3
  - open!/2
  - open!/3
  - read/1
  - read!/1
  - regular?/1
  - rm/1
  - rm!/1
  - rm_rf/1
  - rm_rf!/1
  - rmdir/1
  - rmdir!/1
  - stat/2
  - stat!/2
  - stream!/3
  - touch/2
  - touch!/2
  - write/3
  - write!/3
  - write_stat/3
  - write_stat!/3
File.Stat
- Introduction
- Types
- Functions
  - from_record/1
  - to_record/1
File.Stream
- Introduction
- Types
Float
- Introduction
- Functions
  - ceil/2
  - floor/2
  - parse/1
  - round/2
  - to_char_list/1
  - to_char_list/2
  - to_string/1
  - to_string/2
GenEvent
- Introduction
- Types
- Functions
GenEvent.Stream
- Introduction
- Types
GenServer
- Introduction
- Types
- Functions
  - abcast/3
  - call/3
  - cast/2
  - multi_call/4
  - reply/2
  - start/3
  - start_link/3
HashDict
- Introduction
- Types
- Functions
  - delete/2
  - drop/2
  - equal?/2
  - fetch/2
  - fetch!/2
  - get/3
  - has_key?/2
  - keys/1
  - merge/3
  - new/0
  - pop/3
  - put/3
  - put_new/3
  - size/1
  - split/2
  - take/2
  - to_list/1
  - update/4
  - update!/3
  - values/1
HashSet
- Introduction
- Types
- Functions
  - delete/2
  - difference/2
  - disjoint?/2
  - equal?/2
  - intersection/2
  - member?/2
  - new/0
  - put/2
  - size/1
  - subset?/2
  - to_list/1
  - union/2
IO
- Introduction
- Types
- Functions
  - binread/2
  - binstream/2
  - binwrite/2
  - chardata_to_string/1
  - getn/2
  - getn/3
  - gets/2
  - inspect/2
  - inspect/3
  - iodata_length/1
  - iodata_to_binary/1
  - puts/2
  - read/2
  - stream/2
  - write/2
IO.ANSI
- Introduction
- Types
- Functions
  - black/0
  - black_background/0
  - blink_off/0
  - blink_rapid/0
  - blink_slow/0
  - blue/0
  - blue_background/0
  - bright/0
  - clear/0
  - conceal/0
  - crossed_out/0
  - cyan/0
  - cyan_background/0
  - default_background/0
  - default_color/0
  - enabled?/0
  - encircled/0
  - faint/0
  - font_1/0
  - font_2/0
  - font_3/0
  - font_4/0
  - font_5/0
  - font_6/0
  - font_7/0
  - font_8/0
  - font_9/0
  - format/2
  - format_fragment/2
  - framed/0
  - green/0
  - green_background/0
  - home/0
  - inverse/0
  - italic/0
  - magenta/0
  - magenta_background/0
  - no_underline/0
  - normal/0
  - not_framed_encircled/0
  - not_italic/0
  - not_overlined/0
  - overlined/0
  - primary_font/0
  - red/0
  - red_background/0
  - reset/0
  - reverse/0
  - underline/0
  - white/0
  - white_background/0
  - yellow/0
  - yellow_background/0
IO.Stream
- Introduction
- Types
Inspect.Algebra
- Introduction
- Types
- Functions
  - break/0
  - break/1
  - concat/1
  - concat/2
  - do_surround_many/7
  - empty/0
  - folddoc/2
  - format/2
  - glue/2
  - glue/3
  - group/1
  - line/2
  - nest/2
  - space/2
  - surround/3
  - surround_many/6
  - to_doc/2
Inspect.Opts
- Introduction
- Types
Integer
- Introduction
- Functions
- Macros
Kernel
- Introduction
- Functions
  - !/1
  - !=/2
  - !==/2
  - &&/2
  - */2
  - +/1
  - +/2
  - ++/2
  - -/1
  - -/2
  - --/2
  - ../2
  - //2
  - </2
  - <=/2
  - <>/2
  - ==/2
  - ===/2
  - =~/2
  - >/2
  - >=/2
  - @/1
  - abs/1
  - alias!/1
  - and/2
  - apply/2
  - apply/3
  - binary_part/3
  - binding/1
  - bit_size/1
  - byte_size/1
  - def/2
  - defdelegate/2
  - defexception/1
  - defimpl/3
  - defmacro/2
  - defmacrop/2
  - defmodule/2
  - defoverridable/1
  - defp/2
  - defprotocol/2
  - defstruct/1
  - destructure/2
  - div/2
  - elem/2
  - exit/1
  - function_exported?/3
  - get_and_update_in/2
  - get_and_update_in/3
  - get_in/2
  - hd/1
  - if/2
  - in/2
  - inspect/2
  - is_atom/1
  - is_binary/1
  - is_bitstring/1
  - is_boolean/1
  - is_float/1
  - is_function/1
  - is_function/2
  - is_integer/1
  - is_list/1
  - is_map/1
  - is_number/1
  - is_pid/1
  - is_port/1
  - is_reference/1
  - is_tuple/1
  - length/1
  - macro_exported?/3
  - make_ref/0
  - map_size/1
  - match?/2
  - max/2
  - min/2
  - nil?/1
  - node/0
  - node/1
  - not/1
  - or/2
  - put_elem/3
  - put_in/2
  - put_in/3
  - raise/1
  - raise/2
  - rem/2
  - reraise/2
  - reraise/3
  - round/1
  - self/0
  - send/2
  - sigil_C/2
  - sigil_R/2
  - sigil_S/2
  - sigil_W/2
  - sigil_c/2
  - sigil_r/2
  - sigil_s/2
  - sigil_w/2
  - spawn/1
  - spawn/3
  - spawn_link/1
  - spawn_link/3
  - spawn_monitor/1
  - spawn_monitor/3
  - struct/2
  - throw/1
  - tl/1
  - to_char_list/1
  - to_string/1
  - trunc/1
  - tuple_size/1
  - unless/2
  - update_in/2
  - update_in/3
  - use/2
  - var!/2
  - |>/2
  - ||/2
- Macros
Kernel.ParallelCompiler
- Introduction
- Functions
  - files/2
  - files_to_path/3
Kernel.ParallelRequire
- Introduction
- Functions
  - files/2
Kernel.SpecialForms
- Introduction
- Macros
Kernel.Typespec
- Introduction
- Functions
- Macros
Keyword
- Introduction
- Types
- Functions
  - delete/2
  - delete/3
  - delete_first/2
  - drop/2
  - equal?/2
  - fetch/2
  - fetch!/2
  - get/3
  - get_values/2
  - has_key?/2
  - keys/1
  - keyword?/1
  - merge/2
  - merge/3
  - new/0
  - new/1
  - new/2
  - pop/3
  - pop_first/3
  - put/3
  - put_new/3
  - split/2
  - take/2
  - update/4
  - update!/3
  - values/1
List
- Introduction
- Functions
  - delete/2
  - delete_at/2
  - duplicate/2
  - first/1
  - flatten/1
  - flatten/2
  - foldl/3
  - foldr/3
  - insert_at/3
  - keydelete/3
  - keyfind/4
  - keymember?/3
  - keyreplace/4
  - keysort/2
  - keystore/4
  - last/1
  - replace_at/3
  - to_atom/1
  - to_existing_atom/1
  - to_float/1
  - to_integer/1
  - to_integer/2
  - to_string/1
  - to_tuple/1
  - unzip/1
  - update_at/3
  - wrap/1
  - zip/1
Macro
- Introduction
- Types
- Functions
Macro.Env
- Introduction
- Types
- Functions
Map
- Introduction
- Functions
  - delete/2
  - drop/2
  - equal?/2
  - fetch/2
  - fetch!/2
  - from_struct/1
  - get/3
  - has_key?/2
  - keys/1
  - merge/2
  - merge/3
  - new/0
  - pop/3
  - put/3
  - put_new/3
  - size/1
  - split/2
  - take/2
  - to_list/1
  - update/4
  - update!/3
  - values/1
Module
- Introduction
- Functions
Node
- Introduction
- Types
- Functions
  - alive?/0
  - connect/1
  - disconnect/1
  - get_cookie/0
  - list/0
  - list/1
  - monitor/2
  - monitor/3
  - ping/1
  - self/0
  - set_cookie/2
  - spawn/2
  - spawn/3
  - spawn/4
  - spawn/5
  - spawn_link/2
  - spawn_link/4
  - start/3
  - stop/0
OptionParser
- Introduction
- Types
- Functions
  - next/2
  - parse/2
  - parse_head/2
  - split/1
  - to_argv/1
Path
- Introduction
- Types
- Functions
  - absname/1
  - absname/2
  - basename/1
  - basename/2
  - dirname/1
  - expand/1
  - expand/2
  - extname/1
  - join/1
  - join/2
  - relative/1
  - relative_to/2
  - relative_to_cwd/1
  - rootname/1
  - rootname/2
  - split/1
  - type/1
  - wildcard/2
Port
- Introduction
- Functions
  - call/3
  - close/1
  - command/3
  - connect/2
  - control/3
  - info/1
  - info/2
  - list/0
  - open/2
Process
- Introduction
- Types
- Functions
  - alive?/1
  - delete/1
  - demonitor/2
  - exit/2
  - flag/2
  - flag/3
  - get/0
  - get/2
  - get_keys/1
  - group_leader/0
  - group_leader/2
  - info/1
  - info/2
  - link/1
  - list/0
  - monitor/1
  - put/2
  - register/2
  - registered/0
  - send/3
  - send_after/3
  - spawn/2
  - spawn/4
  - unlink/1
  - unregister/1
  - whereis/1
Protocol
- Introduction
- Functions
- Macros
Range
- Introduction
- Types
- Functions
  - new/2
  - range?/1
Record
- Introduction
- Macros
Regex
- Introduction
- Types
- Functions
  - compile/2
  - compile!/2
  - escape/1
  - match?/2
  - named_captures/3
  - names/1
  - opts/1
  - re_pattern/1
  - regex?/1
  - replace/4
  - run/3
  - scan/3
  - source/1
  - split/3
Set
- Introduction
- Types
- Functions
  - delete/2
  - difference/2
  - disjoint?/2
  - equal?/2
  - intersection/2
  - member?/2
  - new/0
  - put/2
  - size/1
  - subset?/2
  - to_list/1
  - union/2
  - delete/2
  - difference/2
  - disjoint?/2
  - equal?/2
  - intersection/2
  - member?/2
  - put/2
  - size/1
  - subset?/2
  - to_list/1
  - union/2
- Callbacks
Stream
- Introduction
- Types
- Functions
  - chunk/2
  - chunk/4
  - chunk_by/2
  - concat/1
  - concat/2
  - cycle/1
  - drop/2
  - drop_while/2
  - each/2
  - filter/2
  - filter_map/3
  - flat_map/2
  - interval/1
  - into/3
  - iterate/2
  - map/2
  - reject/2
  - repeatedly/1
  - resource/3
  - run/1
  - scan/2
  - scan/3
  - take/2
  - take_every/2
  - take_while/2
  - timer/1
  - transform/3
  - unfold/2
  - uniq/2
  - with_index/1
  - zip/2
String
- Introduction
- Types
- Functions
  - at/2
  - capitalize/1
  - chunk/2
  - codepoints/1
  - contains?/2
  - downcase/1
  - duplicate/2
  - ends_with?/2
  - first/1
  - graphemes/1
  - last/1
  - length/1
  - ljust/2
  - ljust/3
  - lstrip/1
  - lstrip/2
  - match?/2
  - next_codepoint/1
  - next_grapheme/1
  - printable?/1
  - replace/4
  - reverse/1
  - rjust/2
  - rjust/3
  - rstrip/1
  - rstrip/2
  - slice/2
  - slice/3
  - split/1
  - split/3
  - split_at/2
  - starts_with?/2
  - strip/1
  - strip/2
  - to_atom/1
  - to_char_list/1
  - to_existing_atom/1
  - to_float/1
  - to_integer/1
  - to_integer/2
  - upcase/1
  - valid?/1
  - valid_character?/1
StringIO
- Introduction
- Functions
Supervisor
- Introduction
- Types
- Functions
Supervisor.Spec
- Introduction
- Types
- Functions
System
- Introduction
- Functions
  - argv/0
  - argv/1
  - at_exit/1
  - build_info/0
  - cmd/3
  - cwd/0
  - cwd!/0
  - delete_env/1
  - find_executable/1
  - get_env/0
  - get_env/1
  - get_pid/0
  - halt/1
  - put_env/1
  - put_env/2
  - stacktrace/0
  - tmp_dir/0
  - tmp_dir!/0
  - user_home/0
  - user_home!/0
  - version/0
Task
- Introduction
- Types
- Functions
  - __struct__/0
  - async/1
  - async/3
  - await/2
  - find/2
  - start/1
  - start/3
  - start_link/1
  - start_link/3
Task.Supervisor
- Introduction
- Functions
Tuple
- Introduction
- Functions
URI
- Introduction
- Types
- Functions
Version
- Introduction
- Types
- Functions

Access
Collectable
- Introduction
- Types
- Functions
  - empty/1
  - into/1
Enumerable
- Introduction
- Types
- Functions
Inspect
List.Chars
Range.Iterator
- Introduction
- Types
- Functions
  - count/2
  - next/2
String.Chars

ArgumentError
- Functions
  - exception/1
  - message/1
ArithmeticError
- Functions
  - exception/1
  - message/1
BadArityError
- Functions
  - exception/1
  - message/1
BadFunctionError
- Functions
  - exception/1
  - message/1
BadStructError
- Functions
  - exception/1
  - message/1
CaseClauseError
- Functions
  - exception/1
  - message/1
Code.LoadError
- Functions
  - exception/1
  - message/1
CompileError
- Functions
  - exception/1
  - message/1
CondClauseError
- Functions
  - exception/1
  - message/1
Enum.EmptyError
- Functions
  - exception/1
  - message/1
Enum.OutOfBoundsError
- Functions
  - exception/1
  - message/1
ErlangError
- Functions
  - exception/1
  - message/1
File.CopyError
- Functions
  - exception/1
  - message/1
File.Error
- Functions
  - exception/1
  - message/1
FunctionClauseError
- Functions
  - exception/1
  - message/1
IO.StreamError
- Functions
  - exception/1
  - message/1
KeyError
- Functions
  - exception/1
  - message/1
MatchError
- Functions
  - exception/1
  - message/1
Protocol.UndefinedError
- Functions
  - exception/1
  - message/1
Regex.CompileError
- Functions
  - exception/1
  - message/1
RuntimeError
- Functions
  - exception/1
  - message/1
SyntaxError
- Functions
  - exception/1
  - message/1
SystemLimitError
- Functions
  - exception/1
  - message/1
TokenMissingError
- Functions
  - exception/1
  - message/1
TryClauseError
- Functions
  - exception/1
  - message/1
UndefinedFunctionError
- Functions
  - exception/1
  - message/1
UnicodeConversionError
- Functions
  - exception/1
  - message/1
Version.InvalidRequirementError
- Functions
  - exception/1
  - message/1
Version.InvalidVersionError
- Functions
  - exception/1
  - message/1

IO.Stream

Introduction #

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

The following fields are public:

device - the IO device
raw - a boolean indicating if bin functions should be used
line_or_bytes - if reading should read lines or a given amount of bytes

Source

Types #

t :: %IO.Stream{device: term, line_or_bytes: term, raw: term}