#include <joedb/journal/Encoded_File.h>

Inheritance diagram for joedb::Encoded_File:

[legend]

Collaboration diagram for joedb::Encoded_File:

[legend]

Public Member Functions
	Encoded_File (Codec &codec, db::encoded_file::Writable_Database &db)

size_t	pread (char *buffer, size_t size, int64_t offset) const override
	Read a range of bytes.

void	pwrite (const char *buffer, size_t size, int64_t offset) override
	Write a range of bytes. Extend file size if necessary.

int64_t	get_size () const override
	Get the size of the file, or -1 if it is unknown.

void	sync () override
	Write data durably (including file-size change)

	~Encoded_File ()

Public Member Functions inherited from joedb::Readonly_Encoded_File
	Readonly_Encoded_File (Decoder &decoder, const db::encoded_file::Database &db, const Buffered_File &blob_reader)

int64_t	get_size () const override
	Get the size of the file, or -1 if it is unknown.

Public Member Functions inherited from joedb::Buffered_File
	Buffered_File (Open_Mode mode)

void	flush ()

void	flush_for_writing ()

void	exclusive_lock_tail ()

void	unlock_tail () noexcept

bool	tail_is_locked () const noexcept

void	shared_lock_head ()

void	exclusive_lock_head ()

void	unlock_head () noexcept

bool	is_shared () const noexcept

bool	is_readonly () const noexcept

Open_Mode	get_mode () const noexcept

void	set_position (int64_t position)

int64_t	get_position () const noexcept

virtual void	copy_to (Buffered_File &destination, int64_t start, int64_t size) const

virtual bool	equal_to (Buffered_File &destination, int64_t from, int64_t until) const

void	copy_to (Buffered_File &destination) const

template<typename T >
void	write (T x)

template<typename T >
T	read ()

template<typename T >
void	compact_write (T x)

template<typename T >
T	compact_read ()

template<typename T >
T	read_strong_type ()

void	write_reference (Record_Id id)

Record_Id	read_reference ()

void	write_string (const std::string &s)

std::string	read_string ()

std::string	safe_read_string (int64_t max_size)

void	write_blob (Blob blob)

Blob	read_blob ()

void	write_data (const char *data, size_t n)

size_t	read_data (char *data, const size_t n)

void	ignore (const int64_t n)

std::string	read_blob (Blob blob) const

Public Member Functions inherited from joedb::Sequential_File
void	sequential_seek (int64_t new_position)

size_t	sequential_read (char *data, size_t size)

void	sequential_write (const char *data, size_t size)

int64_t	get_position () const

Public Member Functions inherited from joedb::Abstract_File
virtual void	datasync ()
	Write data durably (no file-size change)

virtual void	shared_lock (int64_t start, int64_t size)
	Lock a range of bytes for reading (prevents writes, not reads)

virtual void	exclusive_lock (int64_t start, int64_t size)
	Lock a range of bytes for writing (prevents both writes and reads)

virtual void	unlock (int64_t start, int64_t size) noexcept
	Remove a lock. The range should match the range of a corresponding lock.

virtual	~Abstract_File ()=default

Additional Inherited Members
Static Public Member Functions inherited from joedb::Buffered_File
static void	reading_past_end_of_file ()

Protected Member Functions inherited from joedb::Readonly_Encoded_File
size_t	pread (char *buffer, size_t size, int64_t offset) const override
	Read a range of bytes.

	Readonly_Encoded_File (Decoder &decoder, const db::encoded_file::Database &db, const Buffered_File &blob_reader, Open_Mode mode)

Protected Member Functions inherited from joedb::Buffered_File
void	destructor_flush () noexcept

void	make_readonly ()

void	make_writable ()

Protected Attributes inherited from joedb::Readonly_Encoded_File
Decoder &	decoder

Static Protected Attributes inherited from joedb::Buffered_File
static constexpr int64_t	last_position = (1ULL << 63) - 1

Detailed Description

Definition at line 11 of file Encoded_File.h.

Constructor & Destructor Documentation

◆ Encoded_File()

joedb::Encoded_File::Encoded_File	(	Codec &	codec,
		db::encoded_file::Writable_Database &	db
	)

Definition at line 78 of file Encoded_File.cpp.

◆ ~Encoded_File()

joedb::Encoded_File::~Encoded_File ( )

Definition at line 111 of file Encoded_File.cpp.

Member Function Documentation

◆ get_size()

int64_t joedb::Encoded_File::get_size ( ) const

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 100 of file Encoded_File.cpp.

◆ pread()

size_t joedb::Encoded_File::pread	(	char *	data,
		size_t	size,
		int64_t	offset
	)		const

overridevirtual

The returned value may be less than size, even if the end of the file is not reached. 0 is returned if the end of the file is reached.

Reimplemented from joedb::Abstract_File.

Definition at line 14 of file Encoded_File.cpp.

◆ pwrite()

void joedb::Encoded_File::pwrite	(	const char *	data,
		size_t	size,
		int64_t	offset
	)

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 47 of file Encoded_File.cpp.

◆ sync()

void joedb::Encoded_File::sync ( )

overridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 6 of file Encoded_File.cpp.

The documentation for this class was generated from the following files:

/home/rcoulom/repos/joedb/src/joedb/journal/Encoded_File.h
/home/rcoulom/repos/joedb/src/joedb/journal/Encoded_File.cpp

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Encoded_File()

◆ ~Encoded_File()

Member Function Documentation

◆ get_size()

◆ pread()

◆ pwrite()

◆ sync()