bsa::tes3::file class final

#include <bsa/tes3.hpp>

Base classes

class bsa::components::byte_container

A byte storage container without compression support.

Capacity

auto empty() const -> bool noexcept

Checks if the underlying byte container is empty.

auto size() const -> std::size_t noexcept

Returns the size of the underlying byte container.

Element access

auto as_bytes() const -> std::span<const std::byte> noexcept

Retrieves an immutable view into the underlying bytes.

auto data() const -> const std::byte* noexcept

Retrieves an immutable pointer to the underlying bytes.

Member types

using key = components::key<hashing::hash, hashing::hash_file_in_place>

The key used to indentify a file.

Modifiers

void clear() noexcept

Clears the contents of the file.

void set_data(std::span<const std::byte> a_data) noexcept

Assigns the underlying container to be a non-owning view into the given data.

void set_data(std::vector<std::byte> a_data) noexcept

Assigns the underlying container to be an owning view into the given data.

Reading

void read(read_source a_source)

Reads the contents of the source.

Writing

void write(write_sink a_sink) const

Writes the contents of the object to the destination.

Function documentation