format.h

Go to the documentation of this file.

// Copyright 2023 The Pigweed Authors
//
// Licensed under the Apache License, Version 2.0 (the "License"); you may not
// use this file except in compliance with the License. You may obtain a copy of
// the License at
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
// WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
// License for the specific language governing permissions and limitations under
// the License.
#pragma once
 
 
#include <cstdarg>
 
#include "pw_preprocessor/compiler.h"
#include "pw_span/span.h"
#include "pw_status/status_with_size.h"
#include "pw_string/string.h"
 
namespace pw::string {
 
PW_PRINTF_FORMAT(2, 3)
StatusWithSize Format(span<char> buffer, const char* format, ...);
 
PW_PRINTF_FORMAT(2, 0)
StatusWithSize FormatVaList(span<char> buffer,
                            const char* format,
                            va_list args);
 
PW_PRINTF_FORMAT(2, 3)
Status Format(InlineString<>& string, const char* format, ...);
 
PW_PRINTF_FORMAT(2, 0)
Status FormatVaList(InlineString<>& string, const char* format, va_list args);
 
PW_PRINTF_FORMAT(2, 3)
Status FormatOverwrite(InlineString<>& string, const char* format, ...);
 
PW_PRINTF_FORMAT(2, 0)
inline Status FormatOverwriteVaList(InlineString<>& string,
                                    const char* format,
                                    va_list args) {
  string.clear();
  return FormatVaList(string, format, args);
}
 
}  // namespace pw::string