LogDoctor 2.05
Parse Apache2/Nginx/IIS logs and view dinamically generated statistics
Loading...
Searching...
No Matches
Functions
IOutils Namespace Reference

IOUtils. More...

Functions

const bool exists (std::string_view path)
 Checks the existence of a file/folder.
 
const bool isFile (std::string_view path)
 Checks if a path exists and points to a file.
 
const bool checkFile (std::string_view path, const bool readable=false, const bool writable=false)
 Checks if a path exists, if it points to a file and if the user has read and/or write permissions on it.
 
const bool isDir (std::string_view path)
 Checks if a path exists and points to a directory.
 
const bool checkDir (std::string_view path, const bool readable=false, const bool writable=false)
 Checks if a path exists, if it points to a folder and if the user has read and/or write permissions on it.
 
const bool makeDir (std::string_view path, std::error_code &err) noexcept(true)
 Creates a directory.
 
const bool renameAsCopy (std::string_view path, std::error_code &err) noexcept(true)
 Renames an entry with a trailing '.copy'.
 
void readFile (const std::string &path, std::string &content)
 Reads the content of a file.
 
void randomLines (const std::string &path, std::vector< std::string > &lines, const size_t n_lines=16ul, const bool strip_lines=true)
 Randomly pick lines from a file.
 
void writeOnFile (const std::string &path, std::string_view content)
 Writes a string on file.
 

Detailed Description

IOUtils.

Utilities to work on files

Function Documentation

◆ checkDir()

const bool IOutils::checkDir ( std::string_view  path,
const bool  readable = false,
const bool  writable = false 
)

Checks if a path exists, if it points to a folder and if the user has read and/or write permissions on it.

Parameters
pathThe path of the entry
readableSet to true to check for readability
writableSet to true to check for writability
Returns
The result of the checks

◆ checkFile()

const bool IOutils::checkFile ( std::string_view  path,
const bool  readable = false,
const bool  writable = false 
)

Checks if a path exists, if it points to a file and if the user has read and/or write permissions on it.

Parameters
pathThe path of the entry
readableSet to true to check for readability
writableSet to true to check for writability
Returns
The result of the checks

◆ exists()

const bool IOutils::exists ( std::string_view  path)

Checks the existence of a file/folder.

Parameters
pathThe path of the entry
Returns
The result of the check

◆ isDir()

const bool IOutils::isDir ( std::string_view  path)

Checks if a path exists and points to a directory.

Parameters
pathThe path of the entry
Returns
The result of the checks

◆ isFile()

const bool IOutils::isFile ( std::string_view  path)

Checks if a path exists and points to a file.

Parameters
pathThe path of the entry
Returns
The result of the check

◆ makeDir()

const bool IOutils::makeDir ( std::string_view  path,
std::error_code &  err 
)
noexcept

Creates a directory.

Parameters
pathThe path of the new entry
Returns
Wheter the operation was successful or not

◆ randomLines()

void IOutils::randomLines ( const std::string &  path,
std::vector< std::string > &  lines,
const size_t  n_lines = 16ul,
const bool  strip_lines = true 
)

Randomly pick lines from a file.

Parameters
pathThe path of the entry
linesWill hold the picked lines
n_linesThe number of lines to pick
strip_linesWhether to strip control-characters away from the lines

◆ readFile()

void IOutils::readFile ( const std::string &  path,
std::string &  content 
)

Reads the content of a file.

Parameters
pathThe path of the file to read from
contentWill hold the content of the file

◆ renameAsCopy()

const bool IOutils::renameAsCopy ( std::string_view  path,
std::error_code &  err 
)
noexcept

Renames an entry with a trailing '.copy'.

Parameters
pathThe path of the entry to rename
errWill hold the error, if any
Returns
Wheter the operation was successful or not

◆ writeOnFile()

void IOutils::writeOnFile ( const std::string &  path,
std::string_view  content 
)

Writes a string on file.

Parameters
pathThe path of the file to write on
contentThe string to write