Mercurial > irccd

annotate doc/html/api/module/Irccd.File/index.md @ 254:93a227277786

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Irccd: various fixes for further cross-compilation
author David Demelier <markand@malikania.fr>
date Mon, 05 Sep 2016 12:53:13 +0200
parents c5f4ca941f79
children 904ee87bc808
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 module: Irccd.File
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "File opening and writing."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 ## Usage
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 This class and functions are available for opening and writing files on the disk.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 For convenience, some functions are available as free-functions and some as object methods.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11
13
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
12 ## Remarks
070a1ece2af6 Docs: fix various errors in JavaScript API
David Demelier <markand@malikania.fr>
parents: 0
diff changeset
13
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 <div class="alert alert-warning" role="alert">
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 **Warning**: the stat function and method are optional and may not be available on your system.
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 </div>
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
18 ## Constants
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
19
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 The following properties are defined:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
22 - **SeekCur**: (int) seek from the current file position,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
23 - **SeekEnd**: (int) seek from end of the file,
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
24 - **SeekSet**: (int) seek from beginning of the file.
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
25
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 ## Functions
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
27
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
28 - [basename](function/basename.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
29 - [dirname](function/dirname.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
30 - [exists](function/exists.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
31 - [remove](function/remove.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
32 - [stat](function/stat.html) (Optional)
0
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
33
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 ## Methods
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
35
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
36 - [(constructor)](method/constructor.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
37 - [basename](method/basename.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
38 - [close](method/close.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
39 - [dirname](method/dirname.html)
77
c5f4ca941f79 Irccd: add new Irccd.File.lines function, #445
David Demelier <markand@malikania.fr>
parents: 24
diff changeset
40 - [lines](method/lines.html)
24
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
41 - [read](method/read.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
42 - [readline](method/readline.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
43 - [remove](method/remove.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
44 - [seek](method/seek.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
45 - [stat](method/stat.html) (Optional)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
46 - [tell](method/tell.html)
392778b6d3c9 Docs: arguments are now in bold, #423
David Demelier <markand@malikania.fr>
parents: 13
diff changeset
47 - [write](method/write.html)