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.

drivers/FileSystemLike.h@143:86740a56073b, 2017-05-26 (annotated)

Committer:
AnnaBridge
Date:
Fri May 26 12:30:20 2017 +0100
Revision:
143:86740a56073b
Parent:
138:093f2bd7b9eb 
Release 143 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
<> 128:9bcdf88f62b0 1 /* mbed Microcontroller Library
<> 128:9bcdf88f62b0 2 * Copyright (c) 2006-2013 ARM Limited
<> 128:9bcdf88f62b0 3 *
<> 128:9bcdf88f62b0 4 * Licensed under the Apache License, Version 2.0 (the "License");
<> 128:9bcdf88f62b0 5 * you may not use this file except in compliance with the License.
<> 128:9bcdf88f62b0 6 * You may obtain a copy of the License at
<> 128:9bcdf88f62b0 7 *
<> 128:9bcdf88f62b0 8 * http://www.apache.org/licenses/LICENSE-2.0
<> 128:9bcdf88f62b0 9 *
<> 128:9bcdf88f62b0 10 * Unless required by applicable law or agreed to in writing, software
<> 128:9bcdf88f62b0 11 * distributed under the License is distributed on an "AS IS" BASIS,
<> 128:9bcdf88f62b0 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
<> 128:9bcdf88f62b0 13 * See the License for the specific language governing permissions and
<> 128:9bcdf88f62b0 14 * limitations under the License.
<> 128:9bcdf88f62b0 15 */
<> 128:9bcdf88f62b0 16 #ifndef MBED_FILESYSTEMLIKE_H
<> 128:9bcdf88f62b0 17 #define MBED_FILESYSTEMLIKE_H
<> 128:9bcdf88f62b0 18
<> 128:9bcdf88f62b0 19 #include "platform/platform.h"
<> 128:9bcdf88f62b0 20
<> 128:9bcdf88f62b0 21 #include "drivers/FileBase.h"
<> 128:9bcdf88f62b0 22 #include "drivers/FileHandle.h"
<> 128:9bcdf88f62b0 23 #include "drivers/DirHandle.h"
<> 128:9bcdf88f62b0 24
<> 128:9bcdf88f62b0 25 namespace mbed {
<> 128:9bcdf88f62b0 26 /** \addtogroup drivers */
<> 128:9bcdf88f62b0 27 /** @{*/
<> 128:9bcdf88f62b0 28
<> 128:9bcdf88f62b0 29 /** A filesystem-like object is one that can be used to open files
<> 128:9bcdf88f62b0 30 * though it by fopen("/name/filename", mode)
<> 128:9bcdf88f62b0 31 *
<> 128:9bcdf88f62b0 32 * Implementations must define at least open (the default definitions
<> 128:9bcdf88f62b0 33 * of the rest of the functions just return error values).
<> 128:9bcdf88f62b0 34 *
<> 128:9bcdf88f62b0 35 * @Note Synchronization level: Set by subclass
<> 128:9bcdf88f62b0 36 */
<> 128:9bcdf88f62b0 37 class FileSystemLike : public FileBase {
<> 128:9bcdf88f62b0 38
<> 128:9bcdf88f62b0 39 public:
<> 128:9bcdf88f62b0 40 /** FileSystemLike constructor
<> 128:9bcdf88f62b0 41 *
<> 128:9bcdf88f62b0 42 * @param name The name to use for the filesystem.
<> 128:9bcdf88f62b0 43 */
<> 138:093f2bd7b9eb 44 MBED_DEPRECATED_SINCE("mbed-os-5.4",
<> 138:093f2bd7b9eb 45 "The mbed 2 filesystem classes have been superseeded by the FileSystem api, "
<> 138:093f2bd7b9eb 46 "Replaced by FileSystem")
<> 128:9bcdf88f62b0 47 FileSystemLike(const char *name);
<> 128:9bcdf88f62b0 48
<> 128:9bcdf88f62b0 49 virtual ~FileSystemLike();
<> 128:9bcdf88f62b0 50
<> 138:093f2bd7b9eb 51 MBED_DEPRECATED_SINCE("mbed-os-5.4",
<> 138:093f2bd7b9eb 52 "The mbed 2 filesystem classes have been superseeded by the FileSystem api, "
<> 138:093f2bd7b9eb 53 "Replaced by FileSystem")
<> 128:9bcdf88f62b0 54 static DirHandle *opendir();
<> 128:9bcdf88f62b0 55 friend class BaseDirHandle;
<> 128:9bcdf88f62b0 56
<> 128:9bcdf88f62b0 57 /** Opens a file from the filesystem
<> 128:9bcdf88f62b0 58 *
<> 128:9bcdf88f62b0 59 * @param filename The name of the file to open.
<> 128:9bcdf88f62b0 60 * @param flags One of O_RDONLY, O_WRONLY, or O_RDWR, OR'd with
<> 128:9bcdf88f62b0 61 * zero or more of O_CREAT, O_TRUNC, or O_APPEND.
<> 128:9bcdf88f62b0 62 *
<> 128:9bcdf88f62b0 63 * @returns
<> 128:9bcdf88f62b0 64 * A pointer to a FileHandle object representing the
<> 128:9bcdf88f62b0 65 * file on success, or NULL on failure.
<> 128:9bcdf88f62b0 66 */
<> 128:9bcdf88f62b0 67 virtual FileHandle *open(const char *filename, int flags) = 0;
<> 128:9bcdf88f62b0 68
<> 128:9bcdf88f62b0 69 /** Remove a file from the filesystem.
<> 128:9bcdf88f62b0 70 *
<> 128:9bcdf88f62b0 71 * @param filename the name of the file to remove.
<> 128:9bcdf88f62b0 72 * @param returns 0 on success, -1 on failure.
<> 128:9bcdf88f62b0 73 */
<> 128:9bcdf88f62b0 74 virtual int remove(const char *filename) { (void) filename; return -1; };
<> 128:9bcdf88f62b0 75
<> 128:9bcdf88f62b0 76 /** Rename a file in the filesystem.
<> 128:9bcdf88f62b0 77 *
<> 128:9bcdf88f62b0 78 * @param oldname the name of the file to rename.
<> 128:9bcdf88f62b0 79 * @param newname the name to rename it to.
<> 128:9bcdf88f62b0 80 *
<> 128:9bcdf88f62b0 81 * @returns
<> 128:9bcdf88f62b0 82 * 0 on success,
<> 128:9bcdf88f62b0 83 * -1 on failure.
<> 128:9bcdf88f62b0 84 */
<> 128:9bcdf88f62b0 85 virtual int rename(const char *oldname, const char *newname) { (void) oldname, (void) newname; return -1; };
<> 128:9bcdf88f62b0 86
<> 128:9bcdf88f62b0 87 /** Opens a directory in the filesystem and returns a DirHandle
<> 128:9bcdf88f62b0 88 * representing the directory stream.
<> 128:9bcdf88f62b0 89 *
<> 128:9bcdf88f62b0 90 * @param name The name of the directory to open.
<> 128:9bcdf88f62b0 91 *
<> 128:9bcdf88f62b0 92 * @returns
<> 128:9bcdf88f62b0 93 * A DirHandle representing the directory stream, or
<> 128:9bcdf88f62b0 94 * NULL on failure.
<> 128:9bcdf88f62b0 95 */
<> 128:9bcdf88f62b0 96 virtual DirHandle *opendir(const char *name) { (void) name; return NULL; };
<> 128:9bcdf88f62b0 97
<> 128:9bcdf88f62b0 98 /** Creates a directory in the filesystem.
<> 128:9bcdf88f62b0 99 *
<> 128:9bcdf88f62b0 100 * @param name The name of the directory to create.
<> 128:9bcdf88f62b0 101 * @param mode The permissions to create the directory with.
<> 128:9bcdf88f62b0 102 *
<> 128:9bcdf88f62b0 103 * @returns
<> 128:9bcdf88f62b0 104 * 0 on success,
<> 128:9bcdf88f62b0 105 * -1 on failure.
<> 128:9bcdf88f62b0 106 */
<> 128:9bcdf88f62b0 107 virtual int mkdir(const char *name, mode_t mode) { (void) name, (void) mode; return -1; }
<> 128:9bcdf88f62b0 108
<> 138:093f2bd7b9eb 109 /** Store information about file in stat structure
<> 138:093f2bd7b9eb 110 *
<> 138:093f2bd7b9eb 111 * @param name The name of the file to find information about
<> 138:093f2bd7b9eb 112 * @param st The stat buffer to write to
<> 138:093f2bd7b9eb 113 * @returns
<> 138:093f2bd7b9eb 114 * 0 on success or un-needed,
<> 138:093f2bd7b9eb 115 * -1 on error
<> 138:093f2bd7b9eb 116 */
<> 138:093f2bd7b9eb 117 virtual int stat(const char *name, struct stat *st) { return -1; };
<> 128:9bcdf88f62b0 118 };
<> 128:9bcdf88f62b0 119
<> 128:9bcdf88f62b0 120 } // namespace mbed
<> 128:9bcdf88f62b0 121
<> 128:9bcdf88f62b0 122 #endif
<> 128:9bcdf88f62b0 123
<> 128:9bcdf88f62b0 124 /** @}*/