diff options
| author | Jan Daniel Bothma <[email protected]> | 2012-11-14 18:01:07 +0100 |
|---|---|---|
| committer | Patrik Nyblom <[email protected]> | 2012-12-20 14:58:31 +0100 |
| commit | d96af2dd3333e8870523402de97f022796c34b5c (patch) | |
| tree | 249f1abd9845010afc0ff728ec84f11cce6ef233 | |
| parent | e69d4d80e0dbb1916fb6900a2b47e0fdf85aea61 (diff) | |
| download | otp-d96af2dd3333e8870523402de97f022796c34b5c.tar.gz otp-d96af2dd3333e8870523402de97f022796c34b5c.tar.bz2 otp-d96af2dd3333e8870523402de97f022796c34b5c.zip | |
Basic documentation of the 'ram' mode in the 'file' module
| -rw-r--r-- | lib/kernel/doc/src/file.xml | 6 | ||||
| -rw-r--r-- | lib/kernel/src/file.erl | 5 |
2 files changed, 8 insertions, 3 deletions
diff --git a/lib/kernel/doc/src/file.xml b/lib/kernel/doc/src/file.xml index b2a259080d..89190d8668 100644 --- a/lib/kernel/doc/src/file.xml +++ b/lib/kernel/doc/src/file.xml @@ -610,7 +610,7 @@ <name name="open" arity="2"/> <fsummary>Open a file</fsummary> <desc> - <p>Opens the file <c><anno>Filename</anno></c> in the mode determined + <p>Opens the file <c><anno>File</anno></c> in the mode determined by <c><anno>Modes</anno></c>, which may contain one or more of the following items:</p> <taglist> @@ -767,6 +767,10 @@ <p>The Encoding can be changed for a file "on the fly" by using the <seealso marker="stdlib:io#setopts/2">io:setopts/2</seealso> function, why a file can be analyzed in latin1 encoding for i.e. a BOM, positioned beyond the BOM and then be set for the right encoding before further reading.See the <seealso marker="stdlib:unicode">unicode(3)</seealso> module for functions identifying BOM's.</p> <p>This option is not allowed on <c>raw</c> files.</p> </item> + <tag><c>ram</c></tag> + <item> + <p><c>File</c> must be <c>iodata()</c>. Returns an <c>fd()</c> which lets the <c>file</c> module operate on the data in-memory as if it is a file.</p> + </item> </taglist> <p>Returns:</p> <taglist> diff --git a/lib/kernel/src/file.erl b/lib/kernel/src/file.erl index 22af38c598..85426baba1 100644 --- a/lib/kernel/src/file.erl +++ b/lib/kernel/src/file.erl @@ -88,7 +88,7 @@ | {'cur', Offset :: integer()} | {'eof', Offset :: integer()} | 'bof' | 'cur' | 'eof'. -type mode() :: 'read' | 'write' | 'append' - | 'exclusive' | 'raw' | 'binary' + | 'exclusive' | 'raw' | 'binary' | 'ram' | {'delayed_write', Size :: non_neg_integer(), Delay :: non_neg_integer()} @@ -397,7 +397,8 @@ raw_write_file_info(Name, #file_info{} = Info) -> %% Contemporary mode specification - list of options --spec open(Filename, Modes) -> {ok, IoDevice} | {error, Reason} when +-spec open(File, Modes) -> {ok, IoDevice} | {error, Reason} when + File :: Filename | iodata(), Filename :: name(), Modes :: [mode()], IoDevice :: io_device(), |