Amit Gandhi / mbed-dev_2

t

Fork of mbed-dev by mbed official

platform/FileSystemHandle.h@168:e84263d55307, 2017-06-21 (annotated)

Committer:
AnnaBridge
Date:
Wed Jun 21 17:46:44 2017 +0100
Revision:
168:e84263d55307
Child:
169:9672193075cf
This updates the lib to the mbed lib v 145

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 168:e84263d55307 1 /* mbed Microcontroller Library
AnnaBridge 168:e84263d55307 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 168:e84263d55307 3 *
AnnaBridge 168:e84263d55307 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 168:e84263d55307 5 * you may not use this file except in compliance with the License.
AnnaBridge 168:e84263d55307 6 * You may obtain a copy of the License at
AnnaBridge 168:e84263d55307 7 *
AnnaBridge 168:e84263d55307 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 168:e84263d55307 9 *
AnnaBridge 168:e84263d55307 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 168:e84263d55307 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 168:e84263d55307 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 168:e84263d55307 13 * See the License for the specific language governing permissions and
AnnaBridge 168:e84263d55307 14 * limitations under the License.
AnnaBridge 168:e84263d55307 15 */
AnnaBridge 168:e84263d55307 16 #ifndef MBED_FILESYSTEMHANDLE_H
AnnaBridge 168:e84263d55307 17 #define MBED_FILESYSTEMHANDLE_H
AnnaBridge 168:e84263d55307 18
AnnaBridge 168:e84263d55307 19 #include "platform/platform.h"
AnnaBridge 168:e84263d55307 20
AnnaBridge 168:e84263d55307 21 #include "platform/FileBase.h"
AnnaBridge 168:e84263d55307 22 #include "platform/FileHandle.h"
AnnaBridge 168:e84263d55307 23 #include "platform/DirHandle.h"
AnnaBridge 168:e84263d55307 24
AnnaBridge 168:e84263d55307 25 namespace mbed {
AnnaBridge 168:e84263d55307 26 /** \addtogroup drivers */
AnnaBridge 168:e84263d55307 27 /** @{*/
AnnaBridge 168:e84263d55307 28
AnnaBridge 168:e84263d55307 29
AnnaBridge 168:e84263d55307 30 /** A filesystem-like object is one that can be used to open file-like
AnnaBridge 168:e84263d55307 31 * objects though it by fopen("/name/filename", mode)
AnnaBridge 168:e84263d55307 32 *
AnnaBridge 168:e84263d55307 33 * Implementations must define at least open (the default definitions
AnnaBridge 168:e84263d55307 34 * of the rest of the functions just return error values).
AnnaBridge 168:e84263d55307 35 *
AnnaBridge 168:e84263d55307 36 * @note Synchronization level: Set by subclass
AnnaBridge 168:e84263d55307 37 */
AnnaBridge 168:e84263d55307 38 class FileSystemHandle {
AnnaBridge 168:e84263d55307 39 public:
AnnaBridge 168:e84263d55307 40 /** FileSystemHandle lifetime
AnnaBridge 168:e84263d55307 41 */
AnnaBridge 168:e84263d55307 42 virtual ~FileSystemHandle() {}
AnnaBridge 168:e84263d55307 43
AnnaBridge 168:e84263d55307 44 /** Open a file on the filesystem
AnnaBridge 168:e84263d55307 45 *
AnnaBridge 168:e84263d55307 46 * @param file Destination for the handle to a newly created file
AnnaBridge 168:e84263d55307 47 * @param filename The name of the file to open
AnnaBridge 168:e84263d55307 48 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
AnnaBridge 168:e84263d55307 49 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
AnnaBridge 168:e84263d55307 50 * @return 0 on success, negative error code on failure
AnnaBridge 168:e84263d55307 51 */
AnnaBridge 168:e84263d55307 52 virtual int open(FileHandle **file, const char *filename, int flags) = 0;
AnnaBridge 168:e84263d55307 53
AnnaBridge 168:e84263d55307 54 /** Open a directory on the filesystem
AnnaBridge 168:e84263d55307 55 *
AnnaBridge 168:e84263d55307 56 * @param dir Destination for the handle to the directory
AnnaBridge 168:e84263d55307 57 * @param path Name of the directory to open
AnnaBridge 168:e84263d55307 58 * @return 0 on success, negative error code on failure
AnnaBridge 168:e84263d55307 59 */
AnnaBridge 168:e84263d55307 60 virtual int open(DirHandle **dir, const char *path);
AnnaBridge 168:e84263d55307 61
AnnaBridge 168:e84263d55307 62 /** Remove a file from the filesystem.
AnnaBridge 168:e84263d55307 63 *
AnnaBridge 168:e84263d55307 64 * @param path The name of the file to remove.
AnnaBridge 168:e84263d55307 65 * @return 0 on success, negative error code on failure
AnnaBridge 168:e84263d55307 66 */
AnnaBridge 168:e84263d55307 67 virtual int remove(const char *path);
AnnaBridge 168:e84263d55307 68
AnnaBridge 168:e84263d55307 69 /** Rename a file in the filesystem.
AnnaBridge 168:e84263d55307 70 *
AnnaBridge 168:e84263d55307 71 * @param path The name of the file to rename.
AnnaBridge 168:e84263d55307 72 * @param newpath The name to rename it to
AnnaBridge 168:e84263d55307 73 * @return 0 on success, negative error code on failure
AnnaBridge 168:e84263d55307 74 */
AnnaBridge 168:e84263d55307 75 virtual int rename(const char *path, const char *newpath);
AnnaBridge 168:e84263d55307 76
AnnaBridge 168:e84263d55307 77 /** Store information about the file in a stat structure
AnnaBridge 168:e84263d55307 78 *
AnnaBridge 168:e84263d55307 79 * @param path The name of the file to find information about
AnnaBridge 168:e84263d55307 80 * @param st The stat buffer to write to
AnnaBridge 168:e84263d55307 81 * @return 0 on success, negative error code on failure
AnnaBridge 168:e84263d55307 82 */
AnnaBridge 168:e84263d55307 83 virtual int stat(const char *path, struct stat *st);
AnnaBridge 168:e84263d55307 84
AnnaBridge 168:e84263d55307 85 /** Create a directory in the filesystem.
AnnaBridge 168:e84263d55307 86 *
AnnaBridge 168:e84263d55307 87 * @param path The name of the directory to create.
AnnaBridge 168:e84263d55307 88 * @param mode The permissions with which to create the directory
AnnaBridge 168:e84263d55307 89 * @return 0 on success, negative error code on failure
AnnaBridge 168:e84263d55307 90 */
AnnaBridge 168:e84263d55307 91 virtual int mkdir(const char *path, mode_t mode);
AnnaBridge 168:e84263d55307 92 };
AnnaBridge 168:e84263d55307 93
AnnaBridge 168:e84263d55307 94
AnnaBridge 168:e84263d55307 95 } // namespace mbed
AnnaBridge 168:e84263d55307 96
AnnaBridge 168:e84263d55307 97 #endif
AnnaBridge 168:e84263d55307 98
AnnaBridge 168:e84263d55307 99 /** @}*/