crashpad/util/file/string_file.h
Mark Mentovai 6278690abe Update copyright boilerplate, 2022 edition (Crashpad)
sed -i '' -E -e 's/Copyright (.+) The Crashpad Authors\. All rights reserved\.$/Copyright \1 The Crashpad Authors/' $(git grep -El 'Copyright (.+) The Crashpad Authors\. All rights reserved\.$')

Bug: chromium:1098010
Change-Id: I8d6138469ddbe3d281a5d83f64cf918ec2491611
Reviewed-on: https://chromium-review.googlesource.com/c/crashpad/crashpad/+/3878262
Reviewed-by: Joshua Peraza <jperaza@chromium.org>
Commit-Queue: Mark Mentovai <mark@chromium.org>
2022-09-06 23:54:07 +00:00

83 lines
2.8 KiB
C++
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// Copyright 2014 The Crashpad 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
//
// http://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.
#ifndef CRASHPAD_UTIL_FILE_STRING_FILE_H_
#define CRASHPAD_UTIL_FILE_STRING_FILE_H_
#include <sys/types.h>
#include <string>
#include "base/numerics/safe_math.h"
#include "util/file/file_io.h"
#include "util/file/file_reader.h"
#include "util/file/file_writer.h"
namespace crashpad {
//! \brief A file reader and writer backed by a virtual file, as opposed to a
//! file on disk or other operating system file descriptor-based file.
//!
//! The virtual file is a buffer in memory. This class is convenient for use
//! with other code that normally expects to read or write files, when it is
//! impractical or inconvenient to read or write a file. It is expected that
//! tests, in particular, will benefit from using this class.
class StringFile : public FileReaderInterface, public FileWriterInterface {
public:
StringFile();
StringFile(const StringFile&) = delete;
StringFile& operator=(const StringFile&) = delete;
~StringFile() override;
//! \brief Returns a string containing the virtual files contents.
const std::string& string() const { return string_; }
//! \brief Sets the virtual files contents to \a string, and resets its file
//! position to `0`.
void SetString(const std::string& string);
//! \brief Resets the virtual files contents to be empty, and resets its file
//! position to `0`.
void Reset();
// FileReaderInterface:
FileOperationResult Read(void* data, size_t size) override;
// FileWriterInterface:
bool Write(const void* data, size_t size) override;
bool WriteIoVec(std::vector<WritableIoVec>* iovecs) override;
// FileSeekerInterface:
FileOffset Seek(FileOffset offset, int whence) override;
private:
//! \brief The virtual files contents.
std::string string_;
//! \brief The file offset of the virtual file.
//!
//! \note This is stored in a `size_t` to match the characteristics of
//! #string_, the `std::string` used to store the virtual files contents.
//! This type will have different characteristics than the `off_t` used to
//! report file offsets. The implementation must take care when converting
//! between these distinct types.
base::CheckedNumeric<size_t> offset_;
};
} // namespace crashpad
#endif // CRASHPAD_UTIL_FILE_STRING_FILE_H_