ccpp::File Struct Reference

#include <ccpp/bits/file_implementation.h>

Public Member Functions
	File ()=default
constexpr	File (dius::SyncFile file_, byte *buffer_, usize buffer_capacity_, usize buffer_offset_, usize buffer_size_, BufferMode buffer_mode_, BufferOwnership buffer_ownership_, ReadWriteMode read_write_mode_, Status status_, Permissions permissions_)
constexpr	~File ()
bool	readable () const
bool	writable () const
di::Expected< void, di::GenericCode >	mark_as_readable ()
di::Expected< void, di::GenericCode >	mark_as_writable ()
void	mark_as_eof ()
void	mark_as_error ()
bool	at_eof () const
bool	has_error () const

Public Attributes
dius::SyncFile	file
byte *	buffer { nullptr }
usize	buffer_capacity { 0 }
usize	buffer_offset { 0 }
usize	buffer_size { 0 }
BufferMode	buffer_mode { BufferMode::FullBuffered }
BufferOwnership	buffer_ownership { BufferOwnership::Owned }
ReadWriteMode	read_write_mode { ReadWriteMode::None }
Status	status { Status::None }
Permissions	permissions { Permissions::None }

Constructor & Destructor Documentation

File() [1/2]

ccpp::File::File ( )

explicitdefault

File() [2/2]

ccpp::File::File ( dius::SyncFile file_, byte * buffer_, usize buffer_capacity_, usize buffer_offset_, usize buffer_size_, BufferMode buffer_mode_, BufferOwnership buffer_ownership_, ReadWriteMode read_write_mode_, Status status_, Permissions permissions_ )

inlineexplicitconstexpr

~File()

ccpp::File::~File ( )

inlineconstexpr

Member Function Documentation

at_eof()

bool ccpp::File::at_eof ( ) const

inline

has_error()

bool ccpp::File::has_error ( ) const

inline

mark_as_eof()

void ccpp::File::mark_as_eof ( )

inline

mark_as_error()

void ccpp::File::mark_as_error ( )

inline

mark_as_readable()

di::Expected< void, di::GenericCode > ccpp::File::mark_as_readable ( )

inline

mark_as_writable()

di::Expected< void, di::GenericCode > ccpp::File::mark_as_writable ( )

inline

readable()

bool ccpp::File::readable ( ) const

inline

writable()

bool ccpp::File::writable ( ) const

inline

Member Data Documentation

buffer

byte* ccpp::File::buffer { nullptr }

buffer_capacity

usize ccpp::File::buffer_capacity { 0 }

buffer_mode

BufferMode ccpp::File::buffer_mode { BufferMode::FullBuffered }

buffer_offset

usize ccpp::File::buffer_offset { 0 }

buffer_ownership

BufferOwnership ccpp::File::buffer_ownership { BufferOwnership::Owned }

buffer_size

usize ccpp::File::buffer_size { 0 }

file

dius::SyncFile ccpp::File::file

permissions

Permissions ccpp::File::permissions { Permissions::None }

read_write_mode

ReadWriteMode ccpp::File::read_write_mode { ReadWriteMode::None }

status

Status ccpp::File::status { Status::None }

---

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

• libs/ccpp/include/ccpp/bits/file_implementation.h