/* Copyright (c) 2012 The Chromium Authors. All rights reserved.
* Use of this source code is governed by a BSD-style license that can be
* found in the LICENSE file.
*/
/**
* This file defines the API to create a file system associated with a file.
*/
label Chrome {
M14 = 1.0
};
/**
* The PPB_FileSystem
struct identifies the file system type
* associated with a file.
*/
interface PPB_FileSystem {
/** Create() creates a file system object of the given type.
*
* @param[in] instance A PP_Instance
identifying the instance
* with the file.
* @param[in] type A file system type as defined by
* PP_FileSystemType
enum.
*
* @return A PP_Resource
corresponding to a file system if
* successful.
*/
PP_Resource Create([in] PP_Instance instance, [in] PP_FileSystemType type);
/**
* IsFileSystem() determines if the provided resource is a file system.
*
* @param[in] resource A PP_Resource
corresponding to a file
* system.
*
* @return PP_TRUE
if the resource is a
* PPB_FileSystem
, PP_FALSE
if the resource is
* invalid or some type other than PPB_FileSystem
.
*/
PP_Bool IsFileSystem([in] PP_Resource resource);
/**
* Open() opens the file system. A file system must be opened before running
* any other operation on it.
*
* @param[in] file_system A PP_Resource
corresponding to a file
* system.
* @param[in] expected_size The expected size of the file system.
* @param[in] callback A PP_CompletionCallback
to be called upon
* completion of Open().
*
* @return An int32_t containing an error code from pp_errors.h
.
*/
int32_t Open([in] PP_Resource file_system,
[in] int64_t expected_size,
[in] PP_CompletionCallback callback);
/**
* GetType() returns the type of the provided file system.
*
* @param[in] file_system A PP_Resource
corresponding to a file
* system.
*
* @return A PP_FileSystemType
with the file system type if
* valid or PP_FILESYSTEMTYPE_INVALID
if the provided resource
* is not a valid file system. It is valid to call this function even before
* Open() completes.
*/
PP_FileSystemType GetType([in] PP_Resource file_system);
};