xtd 0.2.0
Loading...
Searching...
No Matches
directory_info.hpp
Go to the documentation of this file.
1
4#pragma once
5#include "file_system_info.hpp"
6#include "../array.hpp"
7#include "../iequatable.hpp"
8#include <iterator>
9#include <memory>
10
12namespace xtd {
14 namespace io {
16 class directory;
17 class file_info;
19
130 class core_export_ directory_info final : public xtd::io::file_system_info {
131 public:
133 class directory_iterator : public xtd::iequatable<directory_iterator> {
134 struct data;
135
136 explicit directory_iterator(const xtd::string& path, const xtd::string& pattern);
137 public:
139 using iterator_category = std::input_iterator_tag;
140 using value_type = xtd::io::directory_info;
141 using difference_type = xtd::io::directory_info;
142 using pointer = xtd::io::directory_info*;
143 using reference = xtd::io::directory_info&;
144
145 directory_iterator();
146 directory_iterator(const directory_iterator&) = default;
147 directory_iterator(directory_iterator&&) = default;
148
149 directory_iterator& operator ++();
150 directory_iterator operator ++(int32);
151 value_type operator *() const;
152 xtd::io::directory_info::directory_iterator begin() const;
153 xtd::io::directory_info::directory_iterator end() const;
154 bool equals(const directory_iterator& other) const noexcept override;
155
156 xtd::string path() const;
157 xtd::string pattern() const;
159
160 private:
161 friend xtd::io::directory;
162 friend xtd::io::directory_info;
163
164 xtd::sptr<data> data_;
165 };
166
168 class file_iterator : public xtd::iequatable<file_iterator> {
169 struct data;
170
171 explicit file_iterator(const std::string& path, const std::string& pattern);
172 public:
174 using iterator_category = std::input_iterator_tag;
175 using value_type = xtd::io::file_info;
176 using difference_type = xtd::io::file_info;
177 using pointer = xtd::io::file_info*;
178 using reference = xtd::io::file_info&;
179
180 file_iterator();
181 file_iterator(const file_iterator&) = default;
182 file_iterator(file_iterator&&) = default;
183
184 file_iterator& operator ++();
185 file_iterator operator ++(int32);
186 value_type operator *() const;
187 xtd::io::directory_info::file_iterator begin() const;
188 xtd::io::directory_info::file_iterator end() const;
189 bool equals(const file_iterator& other) const noexcept override;
190
191 xtd::string path() const;
192 xtd::string pattern() const;
194
195 private:
196 friend xtd::io::directory;
197 friend xtd::io::directory_info;
198
199 xtd::sptr<data> data_;
200 };
201
203 class file_system_info_iterator : public xtd::iequatable<file_system_info_iterator> {
204 struct data;
205
206 explicit file_system_info_iterator(const std::string& path, const std::string& pattern);
207 public:
209 using iterator_category = std::input_iterator_tag;
210 using value_type = xtd::sptr<xtd::io::file_system_info>;
211 using difference_type = xtd::sptr<xtd::io::file_system_info>;
212 using pointer = xtd::sptr<xtd::io::file_system_info>* ;
213 using reference = xtd::sptr<xtd::io::file_system_info>& ;
214
215 file_system_info_iterator();
216 file_system_info_iterator(const file_system_info_iterator&) = default;
217 file_system_info_iterator(file_system_info_iterator&&) = default;
218
219 file_system_info_iterator& operator ++();
220 file_system_info_iterator operator ++(int32);
221 value_type operator *() const;
222 xtd::io::directory_info::file_system_info_iterator begin() const;
223 xtd::io::directory_info::file_system_info_iterator end() const;
224 bool equals(const file_system_info_iterator& other) const noexcept override;
225
226 xtd::string path() const;
227 xtd::string pattern() const;
229
230 private:
231 friend xtd::io::directory;
232 friend xtd::io::directory_info;
233
234 xtd::sptr<data> data_;
235 };
236
238
241 static const directory_info empty;
243
245
286 explicit directory_info(const xtd::string& path);
288
290 directory_info() = default;
292
294
340 [[nodiscard]] auto exists() const -> bool override;
341
366 [[nodiscard]] auto name() const -> xtd::string override;
367
407 [[nodiscard]] auto parent() const -> xtd::io::directory_info;
408
446 [[nodiscard]] auto root() const -> xtd::io::directory_info;
448
450
494 auto create() -> void;
495
541 auto create_subdirectory(const xtd::string& path) const -> xtd::io::directory_info;
542
580 [[nodiscard]] auto enumerate_directories() const -> xtd::io::directory_info::directory_iterator;
601 [[nodiscard]] auto enumerate_directories(const xtd::string& search_pattern) const -> xtd::io::directory_info::directory_iterator;
602
700 [[nodiscard]] auto enumerate_files() const -> xtd::io::directory_info::file_iterator;
777 [[nodiscard]] auto enumerate_files(const xtd::string& search_pattern) const -> xtd::io::directory_info::file_iterator;
778
793 [[nodiscard]] auto enumerate_file_system_infos() const -> xtd::io::directory_info::file_system_info_iterator;
815 [[nodiscard]] auto enumerate_file_system_infos(const xtd::string& search_pattern) const -> xtd::io::directory_info::file_system_info_iterator;
816
854 [[nodiscard]] auto get_directories() const -> xtd::array<xtd::io::directory_info>;
902 [[nodiscard]] auto get_directories(const xtd::string& search_pattern) const -> xtd::array<xtd::io::directory_info>;
903
973 [[nodiscard]] auto get_files() const -> xtd::array<xtd::io::file_info>;
1050 [[nodiscard]] auto get_files(const xtd::string& search_pattern) const -> xtd::array<xtd::io::file_info>;
1051
1135 [[nodiscard]] auto get_file_system_infos() const -> xtd::array<xtd::sptr<xtd::io::file_system_info>>;
1230 [[nodiscard]] auto get_file_system_infos(const xtd::string& search_pattern) const -> xtd::array<xtd::sptr<xtd::io::file_system_info>>;
1231
1284 auto move_to(const xtd::string& dest_dir_name) -> void;
1285
1323 auto remove() const -> void override;
1324
1368 auto remove(bool recursive) const -> void;
1370 };
1371 }
1372}
array.hpp
Contains xtd::array class.
xtd::array
Provides methods for creating, manipulating, searching, and sorting arrays, thereby serving as the ba...
Definition array.hpp:64
xtd::iequatable
Defines a generalized method that a value type or class implements to create a type-specific method f...
Definition iequatable.hpp:23
xtd::iequatable< directory_iterator >::equals
virtual bool equals(const directory_iterator &) const noexcept=0
xtd::io::directory_info::directory_iterator
Represent directory iterator used by xtd::io::directory_info.
Definition directory_info.hpp:133
xtd::io::directory_info::file_iterator
Represent file iterator used by xtd::io::directory_info.
Definition directory_info.hpp:168
xtd::io::directory_info::file_system_info_iterator
Represent file system iterator used by xtd::io::directory_info.
Definition directory_info.hpp:203
xtd::io::directory_info
Exposes instance methods for creating, moving, and enumerating through directories and subdirectories...
Definition directory_info.hpp:130
xtd::io::directory_info::create
auto create() -> void
Creates a directory.
xtd::io::directory_info::create_subdirectory
auto create_subdirectory(const xtd::string &path) const -> xtd::io::directory_info
Creates a subdirectory or subdirectories on the specified path. The specified path can be relative to...
xtd::io::directory_info::parent
auto parent() const -> xtd::io::directory_info
Gets the parent directory of a specified subdirectory.
xtd::io::directory_info::enumerate_directories
auto enumerate_directories() const -> xtd::io::directory_info::directory_iterator
Returns an enumerable collection of directory information in the current directory.
xtd::io::directory_info::root
auto root() const -> xtd::io::directory_info
Gets the root portion of the directory.
xtd::io::directory_info::exists
auto exists() const -> bool override
Gets a value indicating whether the directory exists.
xtd::io::directory_info::directory_info
directory_info(const xtd::string &path)
Initializes a new instance of the xtd::io::directory_info class on the specified path.
xtd::io::directory_info::get_file_system_infos
auto get_file_system_infos() const -> xtd::array< xtd::sptr< xtd::io::file_system_info > >
Returns an array of strongly typed xtd::io::file_system_info entries representing all the files and s...
xtd::io::directory_info::enumerate_files
auto enumerate_files() const -> xtd::io::directory_info::file_iterator
Returns an enumerable collection of file information in the current directory.
xtd::io::directory_info::remove
auto remove() const -> void override
Deletes this xtd::io::directory_info if it is empty.
xtd::io::directory_info::get_directories
auto get_directories() const -> xtd::array< xtd::io::directory_info >
Returns the subdirectories of the current directory.
xtd::io::directory_info::move_to
auto move_to(const xtd::string &dest_dir_name) -> void
Moves a DirectoryInfo instance and its contents to a new path.
xtd::io::directory_info::name
auto name() const -> xtd::string override
Gets the name of this xtd::io::directory_info instance.
xtd::io::directory_info::get_files
auto get_files() const -> xtd::array< xtd::io::file_info >
Returns a file list from the current directory.
xtd::io::directory_info::enumerate_file_system_infos
auto enumerate_file_system_infos() const -> xtd::io::directory_info::file_system_info_iterator
Returns an enumerable collection of file system information in the current directory.
xtd::io::directory_info::empty
static const directory_info empty
Represents the uninitialized xtd::io::directory_info object. This field is constant.
Definition directory_info.hpp:241
xtd::io::directory
Exposes static methods for creating, moving, and enumerating through directories and subdirectories....
Definition directory.hpp:103
xtd::io::file_info
Provides static methods for the creation, copying, deletion, moving, and opening of files,...
Definition file_info.hpp:41
xtd::io::file_system_info
Provides the base class for both xtd::io::file_info and xtd::io::directory_info objects.
Definition file_system_info.hpp:87
xtd::io::file_system_info::file_system_info
file_system_info()=default
Initializes a new instance of the xtd::io::file_system_info class.
xtd::io::path
Performs operations on std::basic_string instances that contain file or directory path information....
Definition path.hpp:37
file_system_info.hpp
Contains xtd::io::file_system_info class.
core_export_
#define core_export_
Define shared library export.
Definition core_export.hpp:13
xtd::string
xtd::basic_string< char > string
Represents text as a sequence of UTF-8 code units.
Definition __string_definitions.hpp:43
xtd::sptr
xtd::shared_ptr_object< type_t > sptr
The xtd::sptr object is a shared pointer.
Definition sptr.hpp:25
xtd::int32
std::int32_t int32
Represents a 32-bit signed integer.
Definition int32.hpp:23
xtd::io::seek_origin::end
@ end
Specifies the end of a stream.
Definition seek_origin.hpp:22
xtd::io::seek_origin::begin
@ begin
Specifies the beginning of a stream.
Definition seek_origin.hpp:18
xtd::platform_id::other
@ other
The operating system is other.
Definition platform_id.hpp:60
iequatable.hpp
Contains xtd::iequatable interface.
xtd::io
The xtd::io namespace contains types that allow reading and writing to files and data streams,...
Definition binary_reader.hpp:17
xtd
The xtd namespace contains all fundamental classes to access Hardware, Os, System,...
Definition abstract_object.hpp:8
xtd::data
constexpr const_pointer data() const noexcept
Gets direct access to the underlying contiguous storage.
Definition read_only_span.hpp:201
Generated on Wed Feb 11 2026 20:07:05 for xtd by Gammasoft. All rights reserved.