文件路径类更多...

#include <path.hpp>

类 path 继承关系图:

类
class	split_iterator
	路径分割迭代器更多...

Public 成员函数
	path ()=default
	默认构造函数，创建空路径
	path (string path) noexcept
	从字符串构造路径
	path (const string_view path)
	从字符串视图构造路径
	path (const char *path)
	从C风格字符串构造路径
NEFORCE_NODISCARD const string &	str () const noexcept
	获取路径字符串
NEFORCE_NODISCARD string_view	view () const noexcept
	获取路径字符串视图
NEFORCE_NODISCARD const char *	data () const noexcept
	获取C风格字符串
NEFORCE_NODISCARD bool	empty () const noexcept
	检查路径是否为空
NEFORCE_NODISCARD split_iterator	begin () const
	获取起始路径组件迭代器
NEFORCE_NODISCARD split_iterator	end () const
	获取结束路径组件迭代器
NEFORCE_NODISCARD path	parent_path () const
	获取父路径
NEFORCE_NODISCARD string_view	filename () const noexcept
	获取文件名
NEFORCE_NODISCARD string_view	stem () const noexcept
	获取文件主名（不含扩展名）
NEFORCE_NODISCARD string_view	extension () const noexcept
	获取文件扩展名
NEFORCE_NODISCARD path	lexically_normal () const
	规范化路径
NEFORCE_NODISCARD path	absolute (const path &base=current_path()) const
	获取绝对路径
NEFORCE_NODISCARD path	relative (const path &base) const
	获取相对于另一路径的路径
path &	operator/= (const path &other)
	路径连接赋值操作符
path &	operator/= (string_view other)
	路径连接赋值操作符（字符串视图版本）
path	operator/ (const path &other) const
	路径连接操作符
path	operator/ (string_view pth) const
	路径连接操作符（字符串视图版本）
NEFORCE_NODISCARD path_tree	to_tree () const
	扫描此路径（必须为目录）并返回路径树
NEFORCE_NODISCARD vector< path >	children (bool include_hidden=false) const
	获取直接子路径列表（非递归）
NEFORCE_NODISCARD vector< path >	child_files (bool include_hidden=false) const
	获取直接子文件路径列表
NEFORCE_NODISCARD vector< path >	child_dirs (bool include_hidden=false) const
	获取直接子目录路径列表
NEFORCE_NODISCARD bool	exists () const noexcept
	检查路径是否存在
NEFORCE_NODISCARD bool	is_directory () const noexcept
	检查路径是否为目录
NEFORCE_NODISCARD bool	is_file () const noexcept
	检查路径是否为普通文件
	operator string_view () const noexcept
	转换为字符串视图
NEFORCE_NODISCARD bool	operator== (const path &rhs) const
	相等比较
NEFORCE_NODISCARD bool	operator< (const path &rhs) const
	小于比较
NEFORCE_NODISCARD size_t	to_hash () const
	计算哈希值
NEFORCE_NODISCARD string	to_string () const
	转换为字符串
void	swap (path &other) noexcept
	交换两个路径
Public 成员函数继承自 icomparable< path >
NEFORCE_NODISCARD constexpr bool	operator== (const path &rhs) const noexcept(noexcept(derived()==rhs))
	相等比较运算符
NEFORCE_NODISCARD constexpr bool	operator!= (const path &rhs) const noexcept(noexcept(!(*this==rhs)))
	不等比较运算符
NEFORCE_NODISCARD constexpr bool	operator< (const path &rhs) const noexcept(noexcept(derived()< rhs))
	小于比较运算符
NEFORCE_NODISCARD constexpr bool	operator> (const path &rhs) const noexcept(noexcept(rhs< derived()))
	大于比较运算符
NEFORCE_NODISCARD constexpr bool	operator<= (const path &rhs) const noexcept(noexcept(!(derived() > rhs)))
	小于等于比较运算符
NEFORCE_NODISCARD constexpr bool	operator>= (const path &rhs) const noexcept(noexcept(!(derived()< rhs)))
	大于等于比较运算符
Public 成员函数继承自 ihashable< path >
NEFORCE_NODISCARD constexpr size_t	to_hash () const noexcept(noexcept(derived().to_hash()))
	获取对象的哈希值
Public 成员函数继承自 istringify< path >
NEFORCE_NODISCARD NEFORCE_CONSTEXPR20 string	to_string () const
	转换为字符串

静态 Public 成员函数
static path	current_path ()
	获取当前工作目录
static path	temp_directory_path ()
	获取临时目录路径
static NEFORCE_NODISCARD bool	exists (const string &path) noexcept
	检查路径是否存在
static NEFORCE_NODISCARD bool	is_directory (const string &path) noexcept
	检查路径是否为目录
static NEFORCE_NODISCARD bool	is_file (const string &path) noexcept
	检查路径是否为文件
static NEFORCE_NODISCARD string_view	extension (string_view path) noexcept
	获取文件扩展名

静态 Public 属性
static constexpr size_t	buffer_size = 8192
	文件操作缓冲区大小
static constexpr auto	spliter
	路径分隔符集合

详细描述

文件路径类

提供跨平台的文件路径操作，包括：

路径组件访问（父路径、文件名、扩展名）
路径规范化（解析.和..）
路径组合（/操作符）
文件系统操作（创建、删除、复制、移动）
路径比较和哈希

在文件 path.hpp 第 36 行定义.

构造及析构函数说明

◆ path() [1/3]

path::path ( string path )

inlineexplicitnoexcept

从字符串构造路径

参数

path 路径字符串

在文件 path.hpp 第 203 行定义.

引用了 path().

◆ path() [2/3]

path::path ( const string_view path )

inlineexplicit

从字符串视图构造路径

参数

path 路径字符串视图

在文件 path.hpp 第 210 行定义.

引用了 path().

◆ path() [3/3]

path::path ( const char * path )

inlineexplicit

从C风格字符串构造路径

参数

path 路径C字符串

在文件 path.hpp 第 217 行定义.

引用了 path().

成员函数说明

◆ absolute()

NEFORCE_NODISCARD path path::absolute ( const path & base = current_path() ) const

获取绝对路径

参数

base 基础路径

返回: 绝对路径

将相对路径转换为绝对路径。

引用了 absolute(), current_path() , 以及 path().

被这些函数引用 absolute().

◆ begin()

NEFORCE_NODISCARD split_iterator path::begin ( ) const

inline

获取起始路径组件迭代器

返回: 指向第一个组件的迭代器

在文件 path.hpp 第 253 行定义.

◆ child_dirs()

NEFORCE_NODISCARD vector< path > path::child_dirs ( bool include_hidden = false ) const

获取直接子目录路径列表

参数

include_hidden 是否包含隐藏目录

引用了 child_dirs() , 以及 path().

被这些函数引用 child_dirs().

◆ child_files()

NEFORCE_NODISCARD vector< path > path::child_files ( bool include_hidden = false ) const

获取直接子文件路径列表

参数

include_hidden 是否包含隐藏文件

返回: 子文件路径列表

引用了 child_files() , 以及 path().

被这些函数引用 child_files().

◆ children()

NEFORCE_NODISCARD vector< path > path::children ( bool include_hidden = false ) const

获取直接子路径列表（非递归）

参数

include_hidden 是否包含隐藏条目

返回: 直接子路径列表

引用了 children() , 以及 path().

被这些函数引用 children().

◆ current_path()

path path::current_path ( )

static

获取当前工作目录

引用了 current_path() , 以及 path().

被这些函数引用 absolute() , 以及 current_path().

◆ data()

NEFORCE_NODISCARD const char * path::data ( ) const

inlinenoexcept

获取C风格字符串

返回: 路径C字符串指针

在文件 path.hpp 第 241 行定义.

◆ empty()

NEFORCE_NODISCARD bool path::empty ( ) const

inlinenoexcept

检查路径是否为空

返回: 是否为空

在文件 path.hpp 第 247 行定义.

◆ end()

NEFORCE_NODISCARD split_iterator path::end ( ) const

inline

获取结束路径组件迭代器

返回: 结束迭代器

在文件 path.hpp 第 259 行定义.

◆ exists() [1/2]

NEFORCE_NODISCARD bool path::exists ( ) const

noexcept

检查路径是否存在

返回: 是否存在

引用了 exists().

被这些函数引用 exists() , 以及 exists().

◆ exists() [2/2]

NEFORCE_NODISCARD bool path::exists ( const string & path )

staticnoexcept

检查路径是否存在

参数

path 要检查的路径字符串

返回: 是否存在

引用了 exists() , 以及 path().

◆ extension() [1/2]

NEFORCE_NODISCARD string_view path::extension ( ) const

noexcept

获取文件扩展名

返回: 扩展名字符串视图

返回文件名的最后一个点之后的部分。

引用了 extension().

被这些函数引用 extension() , 以及 extension().

◆ extension() [2/2]

NEFORCE_NODISCARD string_view path::extension ( string_view path )

staticnoexcept

获取文件扩展名

参数

path 路径字符串视图

返回: 扩展名字符串视图

引用了 extension() , 以及 path().

◆ filename()

NEFORCE_NODISCARD string_view path::filename ( ) const

noexcept

获取文件名

返回: 文件名字符串视图

返回路径的最后一部分。

◆ is_directory() [1/2]

NEFORCE_NODISCARD bool path::is_directory ( ) const

noexcept

检查路径是否为目录

引用了 is_directory().

被这些函数引用 is_directory() , 以及 is_directory().

◆ is_directory() [2/2]

NEFORCE_NODISCARD bool path::is_directory ( const string & path )

staticnoexcept

检查路径是否为目录

参数

path 要检查的路径字符串

引用了 is_directory() , 以及 path().

◆ is_file() [1/2]

NEFORCE_NODISCARD bool path::is_file ( ) const

noexcept

检查路径是否为普通文件

返回: 是否为文件

引用了 is_file().

被这些函数引用 is_file() , 以及 is_file().

◆ is_file() [2/2]

NEFORCE_NODISCARD bool path::is_file ( const string & path )

staticnoexcept

检查路径是否为文件

参数

path 要检查的路径字符串

返回: 是否为文件

引用了 is_file() , 以及 path().

◆ lexically_normal()

NEFORCE_NODISCARD path path::lexically_normal ( ) const

规范化路径

返回: 规范化后的路径

解析路径中的"."和".."，移除多余的分隔符。

引用了 lexically_normal() , 以及 path().

被这些函数引用 lexically_normal() , 以及 to_string().

◆ operator/() [1/2]

path path::operator/ ( const path & other ) const

路径连接操作符

参数

other 要连接的路径

返回: 连接后的新路径

引用了 path().

◆ operator/() [2/2]

path path::operator/ ( string_view pth ) const

路径连接操作符（字符串视图版本）

参数

pth	要连接的路径字符串视图

返回: 连接后的新路径

引用了 path().

◆ operator/=() [1/2]

path & path::operator/= ( const path & other )

路径连接赋值操作符

参数

other 要连接的路径

返回: 自身引用

将另一个路径连接到当前路径，自动处理分隔符。

引用了 path().

◆ operator/=() [2/2]

path & path::operator/= ( string_view other )

路径连接赋值操作符（字符串视图版本）

参数

other 要连接的路径字符串视图

返回: 自身引用

引用了 path().

◆ operator<()

NEFORCE_NODISCARD bool path::operator< ( const path & rhs ) const

小于比较

参数

rhs 另一个路径

返回: 是否小于

引用了 path().

◆ operator==()

NEFORCE_NODISCARD bool path::operator== ( const path & rhs ) const

相等比较

参数

rhs 另一个路径

返回: 是否相等

引用了 path().

◆ parent_path()

NEFORCE_NODISCARD path path::parent_path ( ) const

获取父路径

返回: 父路径对象

引用了 path().

◆ relative()

NEFORCE_NODISCARD path path::relative ( const path & base ) const

获取相对于另一路径的路径

参数

base 基础路径

返回: 相对路径

计算当前路径相对于base路径的相对路径。

引用了 path() , 以及 relative().

被这些函数引用 relative().

◆ stem()

NEFORCE_NODISCARD string_view path::stem ( ) const

noexcept

获取文件主名（不含扩展名）

返回: 文件主名字符串视图

返回文件名去除最后一个点及之后的部分。

引用了 stem().

被这些函数引用 stem().

◆ str()

NEFORCE_NODISCARD const string & path::str ( ) const

inlinenoexcept

获取路径字符串

返回: 路径字符串常量引用

在文件 path.hpp 第 229 行定义.

引用了 str().

被这些函数引用 str().

◆ swap()

void path::swap ( path & other )

inlinenoexcept

交换两个路径

参数

other 要交换的路径

在文件 path.hpp 第 467 行定义.

引用了 path().

◆ temp_directory_path()

path path::temp_directory_path ( )

static

获取临时目录路径

引用了 path() , 以及 temp_directory_path().

被这些函数引用 temp_directory_path().

◆ to_hash()

NEFORCE_NODISCARD size_t path::to_hash ( ) const

计算哈希值

返回: 哈希值

◆ to_string()

NEFORCE_NODISCARD string path::to_string ( ) const

inline

转换为字符串

返回: 规范化后的路径字符串

在文件 path.hpp 第 461 行定义.

引用了 lexically_normal().

◆ to_tree()

NEFORCE_NODISCARD path_tree path::to_tree ( ) const

扫描此路径（必须为目录）并返回路径树

返回: 路径树

引用了 to_tree().

被这些函数引用 to_tree().

◆ view()

NEFORCE_NODISCARD string_view path::view ( ) const

inlinenoexcept

获取路径字符串视图

返回: 路径字符串视图

在文件 path.hpp 第 235 行定义.

引用了 basic_string_view< CharT, Traits >::view().

类成员变量说明

◆ buffer_size

size_t path::buffer_size = 8192

staticconstexpr

文件操作缓冲区大小

默认的I/O缓冲区大小，设置为8KB以获得较好的性能平衡。

在文件 path.hpp 第 43 行定义.

◆ spliter

auto path::spliter

staticconstexpr

初始值:

                              =
 
static constexpr char preferred_separator = spliter[0]

路径分隔符集合

用于路径分割操作，包含所有可能的路径分隔符。

在文件 path.hpp 第 50 行定义.

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

path.hpp

类

Public 成员函数

静态 Public 成员函数

静态 Public 属性

详细描述

构造及析构函数说明

◆ path() [1/3]

◆ path() [2/3]

◆ path() [3/3]

成员函数说明

◆ absolute()

◆ begin()

◆ child_dirs()

◆ child_files()

◆ children()

◆ current_path()

◆ data()

◆ empty()

◆ end()

◆ exists() [1/2]

◆ exists() [2/2]

◆ extension() [1/2]

◆ extension() [2/2]

◆ filename()

◆ is_directory() [1/2]

◆ is_directory() [2/2]

◆ is_file() [1/2]

◆ is_file() [2/2]

◆ lexically_normal()

◆ operator/() [1/2]

◆ operator/() [2/2]

◆ operator/=() [1/2]

◆ operator/=() [2/2]

◆ operator<()

◆ operator==()

◆ parent_path()

◆ relative()

◆ stem()

◆ str()

◆ swap()

◆ temp_directory_path()

◆ to_hash()

◆ to_string()

◆ to_tree()

◆ view()

类成员变量说明

◆ buffer_size

◆ spliter