Classes | Functions
sdf::SDF_VERSION_NAMESPACE::filesystem Namespace Reference

Classes

class  DirIter
 A class for iterating over all items in a directory. More...
 

Functions

template<typename... Args>
std::string append (Args const &... args)
 Append one or more additional path elements to the first passed in argument. More...
 
GZ_SDFORMAT_VISIBLE std::string basename (const std::string &_path)
 Given a path, get just the basename portion. More...
 
GZ_SDFORMAT_VISIBLE bool create_directory (const std::string &_path)
 Create a new directory on the filesystem. More...
 
GZ_SDFORMAT_VISIBLE std::string current_path ()
 Get the current working path. More...
 
GZ_SDFORMAT_VISIBLE bool exists (const std::string &_path)
 Determine whether the given path exists on the filesystem. More...
 
GZ_SDFORMAT_VISIBLE bool is_directory (const std::string &_path)
 Determine whether the given path is a directory. More...
 
GZ_SDFORMAT_VISIBLE std::string const separator (std::string const &_s)
 Append the preferred path separator character for this platform onto the passed-in string. More...
 

Function Documentation

◆ append()

template<typename... Args>
std::string sdf::SDF_VERSION_NAMESPACE::filesystem::append ( Args const &...  args)

Append one or more additional path elements to the first passed in argument.

Parameters
[in]argsThe paths to append together
Returns
A new string with the paths appended together.

References separator().

◆ basename()

GZ_SDFORMAT_VISIBLE std::string sdf::SDF_VERSION_NAMESPACE::filesystem::basename ( const std::string &  _path)

Given a path, get just the basename portion.

Parameters
[in]_pathThe full path.
Returns
A new string with just the basename portion of the path.

◆ create_directory()

GZ_SDFORMAT_VISIBLE bool sdf::SDF_VERSION_NAMESPACE::filesystem::create_directory ( const std::string &  _path)

Create a new directory on the filesystem.

Intermediate directories must already exist.

Parameters
[in]_pathThe new directory path to create
Returns
True if directory creation was successful, false otherwise.

◆ current_path()

GZ_SDFORMAT_VISIBLE std::string sdf::SDF_VERSION_NAMESPACE::filesystem::current_path ( )

Get the current working path.

Returns
Current working path if successful, the empty path on error.

◆ exists()

GZ_SDFORMAT_VISIBLE bool sdf::SDF_VERSION_NAMESPACE::filesystem::exists ( const std::string &  _path)

Determine whether the given path exists on the filesystem.

Parameters
[in]_pathThe path to check for existence
Returns
True if the path exists on the filesystem, false otherwise.

◆ is_directory()

GZ_SDFORMAT_VISIBLE bool sdf::SDF_VERSION_NAMESPACE::filesystem::is_directory ( const std::string &  _path)

Determine whether the given path is a directory.

Parameters
[in]_pathThe path to check
Returns
True if given path exists and is a directory, false otherwise.

◆ separator()

GZ_SDFORMAT_VISIBLE std::string const sdf::SDF_VERSION_NAMESPACE::filesystem::separator ( std::string const &  _s)

Append the preferred path separator character for this platform onto the passed-in string.

Parameters
[in]_sThe path to start with.
Returns
The original path with the platform path separator appended.

Referenced by append().