puffin_format.h File Reference

#include <array>
#include <cstddef>
#include <cstdint>
#include <span>
#include <vector>
#include "iceberg/iceberg_data_export.h"
#include "iceberg/puffin/file_metadata.h"
#include "iceberg/result.h"

Go to the source code of this file.

Classes
struct	iceberg::puffin::PuffinFormat
	Puffin file format constants. More...

Enumerations
enum class	iceberg::puffin::PuffinFlag : uint8_t { kFooterPayloadCompressed = 0 }
	Footer flags for Puffin files. More...

Functions
bool	iceberg::puffin::IsFlagSet (std::span< const uint8_t, 4 > flags, PuffinFlag flag)
	Check if a flag is set in the flags bytes.
void	iceberg::puffin::SetFlag (std::span< uint8_t, 4 > flags, PuffinFlag flag)
	Set a flag in the flags bytes.
Result< std::vector< std::byte > >	iceberg::puffin::Compress (PuffinCompressionCodec codec, std::span< const std::byte > input)
	Compress data using the specified codec.
Result< std::vector< std::byte > >	iceberg::puffin::Decompress (PuffinCompressionCodec codec, std::span< const std::byte > input)
	Decompress data using the specified codec.

Detailed Description

Puffin file format constants and utilities.

Enumeration Type Documentation

PuffinFlag

enum class iceberg::puffin::PuffinFlag : uint8_t

strong

Footer flags for Puffin files.

Enumerator
kFooterPayloadCompressed	Whether the footer payload is compressed.