Components/IFS/src/include/IFS/Debug.h
Go to the documentation of this file.
1 /****
2  * Debug.h
3  *
4  * Copyright 2022 mikee47 <mike@sillyhouse.net>
5  *
6  * This file is part of the IFS Library
7  *
8  * This library is free software: you can redistribute it and/or modify it under the terms of the
9  * GNU General Public License as published by the Free Software Foundation, version 3 or later.
10  *
11  * This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
12  * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  * See the GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along with this library.
16  * If not, see <https://www.gnu.org/licenses/>.
17  *
18  ****/
19 
20 #pragma once
21 
22 #include "FileSystem.h"
23 #include <Print.h>
24 #include <Data/BitSet.h>
25 
26 namespace IFS
27 {
28 namespace Debug
29 {
30 enum class Option {
31  recurse, // Recurse sub-directories
32  attributes, // Include attributes
33 };
34 
36 
37 void printFsInfo(Print& out, FileSystem& fs);
38 void printAttrInfo(Print& out, FileSystem& fs, const String& filename);
39 int listDirectory(Print& out, FileSystem& fs, const String& path, Options options = 0);
40 
41 } // namespace Debug
42 } // namespace IFS
void printFsInfo(Print &out, FileSystem &fs)
The String class.
Definition: WString.h:136
BitSet< uint8_t, Option, 2 > Options
Definition: Components/IFS/src/include/IFS/Debug.h:69
void printAttrInfo(Print &out, FileSystem &fs, const String &filename)
Definition: DirectoryTemplate.h:36
Manage a set of bit values using enumeration.
Definition: BitSet.h:44
int listDirectory(Print &out, FileSystem &fs, const String &path, Options options=0)
Provides formatted output to stream.
Definition: Print.h:36
Option
Definition: Components/IFS/src/include/IFS/Debug.h:64