bsa::components::compressed_byte_container class

#include <bsa/detail/common.hpp>

Base classes

class basic_byte_container

A basic byte storage container.

Derived classes

class bsa::fo4::chunk final

Represents a chunk of a file within the FO4 virtual filesystem.

class bsa::tes4::file final

Represents a file within the TES4 virtual filesystem.

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.

Decompression

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

Retrieves the decompressed size of the compressed storage.

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.

Modifiers

void set_data(std::span<const std::byte> a_data, std::optional<std::size_t> a_decompressedSize = std::nullopt) noexcept

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

void set_data(std::vector<std::byte> a_data, std::optional<std::size_t> a_decompressedSize = std::nullopt) noexcept

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

Observers

auto compressed() const -> bool noexcept

Checks if the underlying bytes are compressed.

Function documentation