Mercurial > irccd

annotate doc/html/api/module/Irccd.File/method/constructor.md @ 0:1158cffe5a5e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 070a1ece2af6
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 method: constructor
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 summary: "Open a file specified by path with the specified mode."
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 synopsis: "Irccd.File(path, mode) /* constructor */"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 arguments:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 - "path, the path to the file,"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 - "mode, the mode, can be one of [abrwt]"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 throws: "Any exception on error"
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 ---
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
10
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 The mode string understands the following characters:
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
12
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 - **a**: append to the end of file,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 - **b**: open in binary mode,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 - **r**: open for reading,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 - **w**: open for writing,
1158cffe5a5e Initial import
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 - **t**: truncate the file.