Nothing Special / mbed-STM32F103C8

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-STM32F103C8_org by Nothing Special

drivers/FileSystemLike.h@146:03e976389d16, 2017-03-16 (annotated)

Committer:
mega64
Date:
Thu Mar 16 06:15:53 2017 +0000
Revision:
146:03e976389d16
fully rebuild, now based on mbed-dev v160

Who changed what in which revision?

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