Kev Mann / mbed-dev-OS5_10_4

RTC auf true

platform/FileSystemHandle.h@2:7aab896b1a3b, 2019-03-13 (annotated)

Committer:
kevman
Date:
Wed Mar 13 11:03:24 2019 +0000
Revision:
2:7aab896b1a3b
Parent:
0:38ceb79fef03 
2019-03-13

Who changed what in which revision?

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