YSTest: platform::HDirectory类 参考

YSTest PreAlpha_b700_20160611 The YSLib Test Project

- 首页
- 相关页面
- 模块
- 命名空间
- 类
- 文件

- 类列表
- 类索引
- 类继承关系
- 类成员

Public 类型 | Public 成员函数 | Public 属性 | Private 类型 | Private 属性 | 相关函数 | 所有成员列表
platform::HDirectory类 参考final

目录句柄：表示打开的目录和内容迭代状态。 更多...

`#include <FileSystem.h>`

类 platform::HDirectory 继承关系图:
[图例]
platform::HDirectory 的协作图:
[图例]

## Public 类型

using | NativeChar = char

## Public 成员函数

DefDeMoveCtor(HDirectory) DefDeMoveAssignment(HDirectory) using ystdex HDirectory & | operator++ ()
| 间接操作：取自身引用。 更多...
| DefBoolNeg (explicit, bool(p_dirent)) DefCvt(const ynothrow
| 判断文件系统节点无效或有效性。 更多...
| GetNativeName ()) operator string() const
| operator u16string () const
NodeCategory | GetNodeCategory () const ynothrow
| 取节点状态信息确定的文件系统节点类别。 更多...
YB_ATTR_returns_nonnull const NativeChar * | GetNativeName () const ynothrow
| 间接操作：取节点名称。 更多...

## Public 属性

| basic_string_view< NativeChar >

## Private 类型

using | DirentData = ::dirent
Private 类型 继承自 platform::DirectorySession
using | Data = void
using | NativeHandle = Data *

## Private 属性

friend | deref_self< HDirectory >
tidy_ptr< DirentData > | p_dirent {}
| 节点信息。 更多...
Private 属性 继承自 platform::DirectorySession
| NativeHandle
string | sDirPath
| 目录路径。 更多...

## 相关函数

(请注意: 这些不是成员函数.)
#define | PDefH(_t, _n, ...)
| 文件迭代器。 更多...

## 额外继承的成员函数

Private 成员函数 继承自 platform::DirectorySession
| DefDeMoveCtor (DirectorySession) DefDeDtor(DirectorySession) DefDeMoveAssignment(DirectorySession) DefGetter(const ynothrow
| 析构：关闭目录路径。 更多...
dir | get ()) void Rewind() ynothrow
| 复位目录状态。 更多...
| DirectorySession ()
| 构造：打开目录路径。 更多...
| YB_NONNULL (2) DirectorySession(const char *)
| YB_NONNULL (2) DirectorySession(const char16_t *)
Private 成员函数 继承自 ystdex::deref_self< HDirectory >
HDirectory & | operator* ()
const HDirectory & | operator* () const
volatile HDirectory & | operator* () volatile
const volatile HDirectory & | operator* () const volatile

## 详细描述

目录句柄：表示打开的目录和内容迭代状态。

自从
  build 411

在文件 YCLib/FileSystem.h 第 500 行定义.

## 成员类型定义说明

using platform::HDirectory::DirentData = ::dirent

private

在文件 YCLib/FileSystem.h 第 520 行定义.

using platform::HDirectory::NativeChar = char

自从
  build 648

在文件 YCLib/FileSystem.h 第 514 行定义.

## 成员函数说明

platform::HDirectory::DefBoolNeg | ( | explicit | ,
|  | bool(p_dirent) |
| ) |  | const

判断文件系统节点无效或有效性。

自从
  build 561
  build 648

const HDirectory::NativeChar * platform::HDirectory::GetNativeName | ( |  | ) | const

自从
  build 593

在文件 YCLib/FileSystem.cpp 第 476 行定义.

参考 platform::Deref() , 以及 YAssert.

函数调用图:

YB_ATTR_returns_nonnull const NativeChar* platform::HDirectory::GetNativeName | ( |  | ) | const

间接操作：取节点名称。

返回
  非空结果：子节点不可用时为对应类型的 `"."` ，否则为子节点名称。

注解
  返回的结果在析构和下一次迭代前保持有效。

自从
  build 648

NodeCategory platform::HDirectory::GetNodeCategory | ( |  | ) | const

取节点状态信息确定的文件系统节点类别。

返回
  未迭代文件时为 NodeCategory::Empty ，否则为对应的其它节点类别。

注解
  不同系统支持的可能不同。

自从
  build 474

在文件 YCLib/FileSystem.cpp 第 422 行定义.

参考 CatchIgnore, platform_ex::Windows::CategorizeNode, platform::Deref(), platform::KeyCodes::Win32::Empty, platform_ex::Windows::Invalid, NPL::A1::name , 以及 YAssert.

函数调用图:

platform::HDirectory::operator u16string | ( |  | ) | const

自从
  build 648

在文件 YCLib/FileSystem.cpp 第 466 行定义.

参考 CHRLib::MakeUCS2LE().

函数调用图:

HDirectory & platform::HDirectory::operator++ | ( |  | ) |

间接操作：取自身引用。

自从
  build 669
  build 549

注解
  使用 ystdex::indirect_input_iterator 和转换函数访问。

自从
  build 556

迭代：向后遍历。

异常

  FileOperationFailure | 读取目录失败。
  FileOperationFailure | 目录没有打开。

在文件 YCLib/FileSystem.cpp 第 409 行定义.

参考 ystdex::make_observer() , 以及 YAssert.

函数调用图:

## 友元及相关函数文档

#define PDefH | ( |  | _t,
|  |  | _n,
|  |  | ...
| ) |  |

related

值:
_t \
_n(__VA_ARGS__)

文件迭代器。

参见
  ystdex::is_undereferenceable

自从
  build 561
  build 411

## 类成员变量说明

platform::HDirectory::basic_string_view< NativeChar >

在文件 YCLib/FileSystem.h 第 565 行定义.

friend platform::HDirectory::deref_self< HDirectory >

private

自从
  build 556

在文件 YCLib/FileSystem.h 第 504 行定义.

tidy_ptr<DirentData> platform::HDirectory::p_dirent {}

private

节点信息。

不变性
  `!p_dirent || bool(GetNativeHandle())` 。
  `!(YCL_Win32 && p_dirent && p_dirent->empty())` 。

自从
  build 669

在文件 YCLib/FileSystem.h 第 529 行定义.

该类的文档由以下文件生成:

- YCLib/FileSystem.h
- YCLib/FileSystem.cpp