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/FileSystemLike.h@147:a97add6d7e64, 2017-07-19 (annotated)

Committer:
Kojto
Date:
Wed Jul 19 16:46:19 2017 +0100
Revision:
147:a97add6d7e64
Parent:
146:22da6e220af6 
Release 147 of the mbed library.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
AnnaBridge 145:64910690c574 1 /* mbed Microcontroller Library
AnnaBridge 145:64910690c574 2 * Copyright (c) 2006-2013 ARM Limited
AnnaBridge 145:64910690c574 3 *
AnnaBridge 145:64910690c574 4 * Licensed under the Apache License, Version 2.0 (the "License");
AnnaBridge 145:64910690c574 5 * you may not use this file except in compliance with the License.
AnnaBridge 145:64910690c574 6 * You may obtain a copy of the License at
AnnaBridge 145:64910690c574 7 *
AnnaBridge 145:64910690c574 8 * http://www.apache.org/licenses/LICENSE-2.0
AnnaBridge 145:64910690c574 9 *
AnnaBridge 145:64910690c574 10 * Unless required by applicable law or agreed to in writing, software
AnnaBridge 145:64910690c574 11 * distributed under the License is distributed on an "AS IS" BASIS,
AnnaBridge 145:64910690c574 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
AnnaBridge 145:64910690c574 13 * See the License for the specific language governing permissions and
AnnaBridge 145:64910690c574 14 * limitations under the License.
AnnaBridge 145:64910690c574 15 */
AnnaBridge 145:64910690c574 16 #ifndef MBED_FILESYSTEMLIKE_H
AnnaBridge 145:64910690c574 17 #define MBED_FILESYSTEMLIKE_H
AnnaBridge 145:64910690c574 18
AnnaBridge 145:64910690c574 19 #include "platform/platform.h"
AnnaBridge 145:64910690c574 20
AnnaBridge 145:64910690c574 21 #include "platform/FileSystemHandle.h"
AnnaBridge 145:64910690c574 22 #include "platform/FileHandle.h"
AnnaBridge 145:64910690c574 23 #include "platform/DirHandle.h"
AnnaBridge 146:22da6e220af6 24 #include "platform/NonCopyable.h"
AnnaBridge 145:64910690c574 25
AnnaBridge 145:64910690c574 26 namespace mbed {
AnnaBridge 145:64910690c574 27 /** \addtogroup platform */
AnnaBridge 145:64910690c574 28
AnnaBridge 145:64910690c574 29
AnnaBridge 145:64910690c574 30 /** A filesystem-like object is one that can be used to open file-like
AnnaBridge 145:64910690c574 31 * objects though it by fopen("/name/filename", mode)
AnnaBridge 145:64910690c574 32 *
AnnaBridge 145:64910690c574 33 * Implementations must define at least open (the default definitions
AnnaBridge 145:64910690c574 34 * of the rest of the functions just return error values).
AnnaBridge 145:64910690c574 35 *
AnnaBridge 145:64910690c574 36 * @note Synchronization level: Set by subclass
AnnaBridge 145:64910690c574 37 * @ingroup platform
AnnaBridge 145:64910690c574 38 */
AnnaBridge 146:22da6e220af6 39 class FileSystemLike : public FileSystemHandle, public FileBase, private NonCopyable<FileSystemLike> {
AnnaBridge 145:64910690c574 40 public:
AnnaBridge 145:64910690c574 41 /** FileSystemLike lifetime
AnnaBridge 145:64910690c574 42 */
AnnaBridge 145:64910690c574 43 FileSystemLike(const char *name = NULL) : FileBase(name, FileSystemPathType) {}
AnnaBridge 145:64910690c574 44 virtual ~FileSystemLike() {}
AnnaBridge 145:64910690c574 45
AnnaBridge 145:64910690c574 46 // Inherited functions with name conflicts
AnnaBridge 145:64910690c574 47 using FileSystemHandle::open;
AnnaBridge 145:64910690c574 48
AnnaBridge 145:64910690c574 49 /** Open a file on the filesystem
AnnaBridge 145:64910690c574 50 *
AnnaBridge 145:64910690c574 51 * @param path The name of the file to open
AnnaBridge 145:64910690c574 52 * @param flags The flags to open the file in, one of O_RDONLY, O_WRONLY, O_RDWR,
AnnaBridge 145:64910690c574 53 * bitwise or'd with one of O_CREAT, O_TRUNC, O_APPEND
AnnaBridge 145:64910690c574 54 * @return A file handle on success, NULL on failure
AnnaBridge 145:64910690c574 55 * @deprecated Replaced by `int open(FileHandle **, ...)` for propagating error codes
AnnaBridge 145:64910690c574 56 */
AnnaBridge 145:64910690c574 57 MBED_DEPRECATED_SINCE("mbed-os-5.5",
AnnaBridge 145:64910690c574 58 "Replaced by `int open(FileHandle **, ...)` for propagating error codes")
AnnaBridge 145:64910690c574 59 FileHandle *open(const char *path, int flags)
AnnaBridge 145:64910690c574 60 {
AnnaBridge 145:64910690c574 61 FileHandle *file;
AnnaBridge 145:64910690c574 62 int err = open(&file, path, flags);
AnnaBridge 145:64910690c574 63 return err ? NULL : file;
AnnaBridge 145:64910690c574 64 }
AnnaBridge 145:64910690c574 65
AnnaBridge 145:64910690c574 66 /** Open a directory on the filesystem
AnnaBridge 145:64910690c574 67 *
AnnaBridge 145:64910690c574 68 * @param path Name of the directory to open
AnnaBridge 145:64910690c574 69 * @return A directory handle on success, NULL on failure
AnnaBridge 145:64910690c574 70 * @deprecated Replaced by `int open(DirHandle **, ...)` for propagating error codes
AnnaBridge 145:64910690c574 71 */
AnnaBridge 145:64910690c574 72 MBED_DEPRECATED_SINCE("mbed-os-5.5",
AnnaBridge 145:64910690c574 73 "Replaced by `int open(DirHandle **, ...)` for propagating error codes")
AnnaBridge 145:64910690c574 74 DirHandle *opendir(const char *path)
AnnaBridge 145:64910690c574 75 {
AnnaBridge 145:64910690c574 76 DirHandle *dir;
AnnaBridge 145:64910690c574 77 int err = open(&dir, path);
AnnaBridge 145:64910690c574 78 return err ? NULL : dir;
AnnaBridge 145:64910690c574 79 }
AnnaBridge 145:64910690c574 80 };
AnnaBridge 145:64910690c574 81
AnnaBridge 145:64910690c574 82
AnnaBridge 145:64910690c574 83 } // namespace mbed
AnnaBridge 145:64910690c574 84
AnnaBridge 145:64910690c574 85 #endif