spdlog::details::file_helper Class Reference

#include <file_helper.h>

Public Member Functions
	file_helper ()=default
	file_helper (const file_helper &)=delete
file_helper &	operator= (const file_helper &)=delete
	~file_helper ()
void	open (const filename_t &fname, bool truncate=false)
void	reopen (bool truncate)
void	flush ()
void	close ()
void	write (const fmt::memory_buffer &buf)
size_t	size () const
const filename_t &	filename () const

Static Public Member Functions
static bool	file_exists (const filename_t &fname)
static std::tuple< filename_t, filename_t >	split_by_extension (const spdlog::filename_t &fname)

Public Attributes
const int	open_tries = 5
const int	open_interval = 10

Private Attributes
std::FILE *	fd_ {nullptr}
filename_t	_filename

Detailed Description

Definition at line 25 of file file_helper.h.

Constructor & Destructor Documentation

spdlog::details::file_helper::file_helper ( )

explicitdefault

spdlog::details::file_helper::file_helper ( const file_helper &  )

delete

spdlog::details::file_helper::~file_helper ( )

inline

Definition at line 37 of file file_helper.h.

    {
        close();
    }

Member Function Documentation

void spdlog::details::file_helper::close ( )

inline

Definition at line 74 of file file_helper.h.

    {
        if (fd_ != nullptr)
        {
            std::fclose(fd_);
            fd_ = nullptr;
        }
    }

static bool spdlog::details::file_helper::file_exists ( const filename_t &  fname )

inlinestatic

Definition at line 107 of file file_helper.h.

    {
        return os::file_exists(fname);
    }

const filename_t& spdlog::details::file_helper::filename ( ) const

inline

Definition at line 102 of file file_helper.h.

    {
        return _filename;
    }

void spdlog::details::file_helper::flush ( )

inline

Definition at line 69 of file file_helper.h.

    {
        std::fflush(fd_);
    }

void spdlog::details::file_helper::open ( const filename_t &  fname, bool  truncate = false  )

inline

Definition at line 42 of file file_helper.h.

    {
        close();
        auto *mode = truncate ? SPDLOG_FILENAME_T("wb") : SPDLOG_FILENAME_T("ab");
        _filename = fname;
        for (int tries = 0; tries < open_tries; ++tries)
        {
            if (!os::fopen_s(&fd_, fname, mode))
            {
                return;
            }

            details::os::sleep_for_millis(open_interval);
        }

        throw spdlog_ex("Failed opening file " + os::filename_to_str(_filename) + " for writing", errno);
    }

file_helper& spdlog::details::file_helper::operator= ( const file_helper &  )

delete

void spdlog::details::file_helper::reopen ( bool  truncate )

inline

Definition at line 60 of file file_helper.h.

    {
        if (_filename.empty())
        {
            throw spdlog_ex("Failed re opening file - was not opened before");
        }
        open(_filename, truncate);
    }

size_t spdlog::details::file_helper::size ( void  ) const

inline

Definition at line 93 of file file_helper.h.

    {
        if (fd_ == nullptr)
        {
            throw spdlog_ex("Cannot use size() on closed file " + os::filename_to_str(_filename));
        }
        return os::filesize(fd_);
    }

static std::tuple<filename_t, filename_t> spdlog::details::file_helper::split_by_extension ( const spdlog::filename_t &  fname )

inlinestatic

Definition at line 125 of file file_helper.h.

    {
        auto ext_index = fname.rfind('.');

        // no valid extension found - return whole path and empty string as
        // extension
        if (ext_index == filename_t::npos || ext_index == 0 || ext_index == fname.size() - 1)
        {
            return std::make_tuple(fname, spdlog::filename_t());
        }

        // treat casese like "/etc/rc.d/somelogfile or "/abc/.hiddenfile"
        auto folder_index = fname.rfind(details::os::folder_sep);
        if (folder_index != filename_t::npos && folder_index >= ext_index - 1)
        {
            return std::make_tuple(fname, spdlog::filename_t());
        }

        // finally - return a valid base and extension tuple
        return std::make_tuple(fname.substr(0, ext_index), fname.substr(ext_index));
    }

void spdlog::details::file_helper::write ( const fmt::memory_buffer &  buf )

inline

Definition at line 83 of file file_helper.h.

    {
        size_t msg_size = buf.size();
        auto data = buf.data();
        if (std::fwrite(data, 1, msg_size, fd_) != msg_size)
        {
            throw spdlog_ex("Failed writing to file " + os::filename_to_str(_filename), errno);
        }
    }

Member Data Documentation

filename_t spdlog::details::file_helper::_filename

private

Definition at line 149 of file file_helper.h.

std::FILE* spdlog::details::file_helper::fd_ {nullptr}

private

Definition at line 148 of file file_helper.h.

const int spdlog::details::file_helper::open_interval = 10

Definition at line 30 of file file_helper.h.

const int spdlog::details::file_helper::open_tries = 5

Definition at line 29 of file file_helper.h.

---

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

• wire-cell-build/util/inc/spdlog/details/file_helper.h