#include <joedb/journal/Readonly_Memory_File.h>

Inheritance diagram for joedb::Readonly_Memory_File:

[legend]

Collaboration diagram for joedb::Readonly_Memory_File:

[legend]

Public Member Functions
	Readonly_Memory_File (const void *memory, size_t size)

	Readonly_Memory_File (const std::string &s)

	Readonly_Memory_File (const std::vector< char > &v)

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

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	pwrite (const char *data, size_t size, int64_t offset)
	Write a range of bytes. Extend file size if necessary.

virtual void	sync ()
	Write data and meta-data (such as file size) durably to permanent storage.

virtual void	datasync ()
	Write data durably to permanent storage.

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

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

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

void	make_readonly ()

void	make_writable ()

Protected Attributes
const char *	data

const size_t	data_size

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

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

Detailed Description

Definition at line 11 of file Readonly_Memory_File.h.

Constructor & Destructor Documentation

◆ Readonly_Memory_File() [1/3]

joedb::Readonly_Memory_File::Readonly_Memory_File	(	const void *	memory,
		size_t	size
	)

inline

Definition at line 31 of file Readonly_Memory_File.h.

◆ Readonly_Memory_File() [2/3]

joedb::Readonly_Memory_File::Readonly_Memory_File ( const std::string & s )

inline

Definition at line 40 of file Readonly_Memory_File.h.

◆ Readonly_Memory_File() [3/3]

joedb::Readonly_Memory_File::Readonly_Memory_File ( const std::vector< char > & v )

inline

Definition at line 47 of file Readonly_Memory_File.h.

Member Function Documentation

◆ get_size()

int64_t joedb::Readonly_Memory_File::get_size ( ) const

inlineoverridevirtual

Reimplemented from joedb::Abstract_File.

Definition at line 54 of file Readonly_Memory_File.h.

◆ pread()

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

inlineoverrideprotectedvirtual

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 18 of file Readonly_Memory_File.h.

Member Data Documentation

◆ data

const char* joedb::Readonly_Memory_File::data

protected

Definition at line 14 of file Readonly_Memory_File.h.

◆ data_size

const size_t joedb::Readonly_Memory_File::data_size

protected

Definition at line 15 of file Readonly_Memory_File.h.

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

/home/rcoulom/repos/joedb/src/joedb/journal/Readonly_Memory_File.h

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Readonly_Memory_File() [1/3]

◆ Readonly_Memory_File() [2/3]

◆ Readonly_Memory_File() [3/3]

Member Function Documentation

◆ get_size()

◆ pread()

Member Data Documentation

◆ data

◆ data_size