escape-string.hh

Go to the documentation of this file.

#pragma once
 
#include <limits>
#include <ostream>
 
namespace nix {

struct EscapeStringOptions
{
    size_t maxLength = std::numeric_limits<size_t>::max();

    bool outputAnsiColors = false;

    bool escapeNonPrinting = false;
};

std::ostream &
escapeString(std::ostream & output, std::string_view s, EscapeStringOptions options = {});
 
inline std::ostream & escapeString(std::ostream & output, const char * s)
{
    return escapeString(output, std::string_view(s));
}
 
inline std::ostream & escapeString(std::ostream & output, const std::string & s)
{
    return escapeString(output, std::string_view(s));
}

std::string escapeString(std::string_view s, EscapeStringOptions options = {});
 
inline std::string escapeString(const char * s, EscapeStringOptions options = {})
{
    return escapeString(std::string_view(s), options);
}
 
} // namespace nix