cv::utils::fs namespace#

Core functionality » Utility and system functions and macros

Function Documentation#

canonical()#

cv::String cv::utils::fs::canonical(const cv::String &path)#

Converts path p to a canonical absolute path Symlinks are processed if there is support for them on running platform.

Parameters:

path – input path. Target file/directory should exist.

createDirectories()#

bool cv::utils::fs::createDirectories(const cv::String &path)#

createDirectory()#

bool cv::utils::fs::createDirectory(const cv::String &path)#

exists()#

bool cv::utils::fs::exists(const cv::String &path)#

getCacheDirectoryForDownloads()#

cv::String cv::utils::fs::getCacheDirectoryForDownloads()#

getcwd()#

cv::String cv::utils::fs::getcwd()#

getParent()#

cv::String cv::utils::fs::getParent(const cv::String &path)#

Get parent directory

getParent()#

std::wstring cv::utils::fs::getParent(const std::wstring &path)#

glob()#

void cv::utils::fs::glob(const cv::String &directory, const cv::String &pattern, std::vector<cv::String> &result, bool recursive = false, bool includeDirectories = false)#

Generate a list of all files that match the globbing pattern.

Result entries are prefixed by base directory path.

Parameters:

  • directory – base directory

  • pattern – filter pattern (based on ‘*’/’?’ symbols). Use empty string to disable filtering and return all results

  • result – [out] result of globing.

  • recursive – scan nested directories too

  • includeDirectories – include directories into results list

glob_relative()#

void cv::utils::fs::glob_relative(const cv::String &directory, const cv::String &pattern, std::vector<cv::String> &result, bool recursive = false, bool includeDirectories = false)#

Generate a list of all files that match the globbing pattern.

Parameters:

  • directory – base directory

  • pattern – filter pattern (based on ‘*’/’?’ symbols). Use empty string to disable filtering and return all results

  • result – [out] globbing result with relative paths from base directory

  • recursive – scan nested directories too

  • includeDirectories – include directories into results list

isDirectory()#

bool cv::utils::fs::isDirectory(const cv::String &path)#

join()#

cv::String cv::utils::fs::join(const cv::String &base, const cv::String &path)#

Join path components

remove_all()#

void cv::utils::fs::remove_all(const cv::String &path)#