Gan likun / mbed-dev11

platform/FileSystemHandle.h@0:06036f8bee2d, 2022-10-24 (annotated)

Committer:
ganlikun
Date:
Mon Oct 24 15:19:39 2022 +0000
Revision:
0:06036f8bee2d
11

Who changed what in which revision?

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