mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

platform/FileSystemHandle.h@171:3a7713b1edbc, 2018-11-08 (annotated)

Committer:
AnnaBridge
Date:
Thu Nov 08 11:45:42 2018 +0000
Revision:
171:3a7713b1edbc
Parent:
170:e95d10626187
Child:
172:65be27845400
mbed library. Release version 164

Who changed what in which revision?

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