FileSystemPath Class Reference

#include <FileSystemPath.h>

Public Member Functions
	FileSystemPath (std::string_view path)
	FileSystemPath (FileSystemPathView path)
	FileSystemPath ()=default
	FileSystemPath (const FileSystemPath &)=default
	FileSystemPath (FileSystemPath &&)=default
FileSystemPath &	operator= (const FileSystemPath &)=default
FileSystemPath &	operator= (FileSystemPath &&)=default
bool	isEmpty () const
bool	isPrefixOf (FileSystemPathView path) const
bool	isEscaping () const
const std::string &	string () const
auto	split () const
FileSystemPathComponents	components () const
FileSystemPath &	operator/= (std::string_view tail)
FileSystemPath &	operator/= (FileSystemPathView tail)

Static Public Member Functions
static FileSystemPath	fromNormalized (std::string path)

Private Attributes
std::string	_path

Friends
auto	operator<=> (const FileSystemPath &l, const FileSystemPath &r)=default

Detailed Description

FileSystemPath does path normalization for FileSystem, transforming passed paths into a normal form of "foo/bar/baz":

• Windows-style path separators are replaced with unix-style ones.
• Repeated path separators are replaced with a single one.
• Leading & trailing path separators are removed.
• "." and ".." are collapsed.
• Root path is stored as an empty string.

Note that this means that FileSystemPath is different from std::filesystem::path in that there is no difference between a file and a directory at the path level. "foo/bar/." is normalized into "foo/bar", and can then be used to open a file for reading.

Constructor & Destructor Documentation

FileSystemPath() [1/5]

FileSystemPath::FileSystemPath ( std::string_view  path )

explicit

FileSystemPath() [2/5]

FileSystemPath::FileSystemPath ( FileSystemPathView  path )

inlineexplicit

FileSystemPath() [3/5]

FileSystemPath::FileSystemPath ( )

default

Constructs a root path.

FileSystemPath() [4/5]

FileSystemPath::FileSystemPath ( const FileSystemPath &  )

default

FileSystemPath() [5/5]

FileSystemPath::FileSystemPath ( FileSystemPath &&  )

default

Member Function Documentation

components()

FileSystemPathComponents FileSystemPath::components ( ) const

inline

fromNormalized()

static FileSystemPath FileSystemPath::fromNormalized ( std::string  path )

inlinestatic

isEmpty()

bool FileSystemPath::isEmpty ( ) const

inline

isEscaping()

bool FileSystemPath::isEscaping ( ) const

inline

isPrefixOf()

bool FileSystemPath::isPrefixOf ( FileSystemPathView  path ) const

inline

operator/=() [1/2]

FileSystemPath & FileSystemPath::operator/=

(

FileSystemPathView

tail

)

operator/=() [2/2]

FileSystemPath & FileSystemPath::operator/=

(

std::string_view

tail

)

operator=() [1/2]

FileSystemPath & FileSystemPath::operator= ( const FileSystemPath &  )

default

operator=() [2/2]

FileSystemPath & FileSystemPath::operator= ( FileSystemPath &&  )

default

split()

auto FileSystemPath::split ( ) const

inline

string()

const std::string & FileSystemPath::string ( ) const

inline

Friends And Related Function Documentation

operator<=>

auto operator<=> ( const FileSystemPath &  l, const FileSystemPath &  r  )

friend

Member Data Documentation

_path

std::string FileSystemPath::_path

private

---

The documentation for this class was generated from the following files:

• src/Library/FileSystem/Interface/FileSystemPath.h
• src/Library/FileSystem/Interface/FileSystemPath.cpp