ppapi/api/pp_file_info.idl

   1 /* Copyright (c) 2011 The Chromium Authors. All rights reserved.
   2  * Use of this source code is governed by a BSD-style license that can be
   3  * found in the LICENSE file.
   4  */
   5
   6 /**
   7  * This file defines three enumerations for use in the PPAPI C file IO APIs.
   8  */
   9
  10 /**
  11  * The <code>PP_FileType</code> enum contains file type constants.
  12  */
  13 [assert_size(4)]
  14 enum PP_FileType {
  15   /** A regular file type */
  16   PP_FILETYPE_REGULAR = 0,
  17   /** A directory */
  18   PP_FILETYPE_DIRECTORY = 1,
  19   /** A catch-all for unidentified types */
  20   PP_FILETYPE_OTHER = 2
  21 };
  22
  23 /**
  24  * The <code>PP_FileSystemType</code> enum contains file system type constants.
  25  */
  26 [assert_size(4)]
  27 enum PP_FileSystemType {
  28   /** For identified invalid return values */
  29   PP_FILESYSTEMTYPE_INVALID = 0,
  30   /** For external file system types */
  31   PP_FILESYSTEMTYPE_EXTERNAL = 1,
  32   /** For local persistant file system types */
  33   PP_FILESYSTEMTYPE_LOCALPERSISTENT = 2,
  34   /** For local temporary file system types */
  35   PP_FILESYSTEMTYPE_LOCALTEMPORARY = 3
  36 };
  37
  38 /**
  39  * The <code>PP_FileInfo</code> struct represents all information about a file,
  40  * such as size, type, and creation time.
  41  */
  42 [assert_size(40)]
  43 struct PP_FileInfo {
  44   /** This value represents the size of the file measured in bytes */
  45   int64_t size;
  46
  47   /**
  48    * This value represents the type of file as defined by the
  49    * <code>PP_FileType</code> enum
  50    */
  51   PP_FileType type;
  52
  53   /**
  54    * This value represents the file system type of the file as defined by the
  55    * <code>PP_FileSystemType</code> enum.
  56    */
  57   PP_FileSystemType system_type;
  58
  59   /**
  60    * This value represents the creation time of the file.
  61    */
  62   PP_Time creation_time;
  63
  64   /**
  65    * This value represents the last time the file was accessed.
  66    */
  67   PP_Time last_access_time;
  68
  69   /**
  70    * This value represents the last time the file was modified.
  71    */
  72   PP_Time last_modified_time;
  73 };
  74