diff doc/html/api/module/Irccd.File/function/stat.md @ 0:1158cffe5a5e

Initial import
author David Demelier <markand@malikania.fr>
date Mon, 08 Feb 2016 16:43:14 +0100
parents
children 070a1ece2af6
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/html/api/module/Irccd.File/function/stat.md	Mon Feb 08 16:43:14 2016 +0100
@@ -0,0 +1,29 @@
+---
+function: stat
+summary: "Get file information at the specified path."
+synopsis: "info = Irccd.File.stat(path)"
+arguments:
+  - "path, the path to the file."
+returns: "The stats information"
+throws: "Any exception on error."
+---
+
+<div class="alert alert-warning" role="alert">
+**Warning**: this function is optional and may not be available on your system.
+</div>
+
+The returned object may have the following properties if they are available on your system:
+
+  - **atime**: (int) the last access time,
+  - **blksize**: (int) the block size,
+  - **blocks**: (int) the number of blocks,
+  - **ctime**: (int) the creation time,
+  - **dev**: (int) the device,
+  - **gid**: (int) the group,
+  - **ino**: (int) the inode,
+  - **mode**: (int) the mode,
+  - **mtime**: (int) the modification time,
+  - **nlink**: (int) the number of hard links,
+  - **rdev**: (int),
+  - **size**: (int) the file size,
+  - **uid**: (int) the user.