format.h File Reference

#include <cstdarg>
#include "pw_preprocessor/compiler.h"
#include "pw_span/span.h"
#include "pw_status/status_with_size.h"
#include "pw_string/string.h"

Go to the source code of this file.

Namespaces
namespace	pw
	The Pigweed namespace.

Functions
StatusWithSize	pw::string::Format (span< char > buffer, const char *format,...)
StatusWithSize	pw::string::FormatVaList (span< char > buffer, const char *format, va_list args)
Status	pw::string::Format (InlineString<> &string, const char *format,...)
Status	pw::string::FormatVaList (InlineString<> &string, const char *format, va_list args)
Status	pw::string::FormatOverwrite (InlineString<> &string, const char *format,...)
Status	pw::string::FormatOverwriteVaList (InlineString<> &string, const char *format, va_list args)

Detailed Description

The pw::string::Format functions are safer alternatives to std::snprintf and std::vsnprintf. The snprintf return value is awkward to interpret, and misinterpreting it can lead to serious bugs.

These functions return a pw::StatusWithSize. The pw::Status is set to reflect any errors and the return value is always the number of characters written before the null terminator.