libeditwl
Lightweight C++ library for Nintendo DS(i) formats
Loading...
Searching...
No Matches
twl::fs::BufferFile Class Reference
Inheritance diagram for twl::fs::BufferFile:
twl::fs::File twl::fs::AbstractReaderWriter

Public Member Functions

 BufferFile (size_t buf_size)
 
 BufferFile (void *buf, size_t buf_size, const bool transfer_ownership=true)
 
 BufferFile (const BufferFile &)=delete
 
 BufferFile (BufferFile &&)=default
 
void CreateAllocate (size_t buf_size)
 
void CreateFrom (void *buf, size_t buf_size, const bool transfer_ownership=true)
 
void Dispose ()
 
bool IsValid ()
 
void * GetBuffer ()
 
size_t GetBufferSize ()
 
Result OpenImpl (const FileMode mode) override
 
Result GetSizeImpl (size_t &out_size) override
 
Result SetOffsetImpl (const size_t offset, const Whence whence) override
 
Result GetOffsetImpl (size_t &out_offset) override
 
Result ReadBufferImpl (void *read_buf, const size_t read_size) override
 
Result WriteBufferImpl (const void *write_buf, const size_t write_size) override
 
Result CloseImpl () override
 
- Public Member Functions inherited from twl::fs::File
 File (const File &)=delete
 
 File (File &&)=default
 
bool IsOpened ()
 
constexpr bool IsCompressed ()
 
Result OpenRead ()
 
Result OpenWrite (const FileCompression comp=FileCompression::None)
 
Result OpenUpdate ()
 
Result GetSize (size_t &out_size) override
 
Result SetOffset (const ssize_t offset, const Whence whence) override
 
Result GetOffset (size_t &out_offset) override
 
Result ReadBuffer (void *read_buf, const size_t read_size) override
 
Result WriteBuffer (const void *write_buf, const size_t write_size) override
 
Result Close ()
 
- Public Member Functions inherited from twl::fs::AbstractReaderWriter
Result SetAbsoluteOffset (const size_t offset)
 
Result MoveOffset (const ssize_t offset)
 
template<typename T>
Result Read (T &out_t)
 
template<typename T>
Result Write (const T &t)
 
template<typename T>
Result ReadLEB128 (T &out_t)
 
template<typename C>
Result ReadNullTerminatedString (std::basic_string< C > &out_str, const size_t tmp_buf_size=0x200)
 
template<typename C>
Result WriteString (const std::basic_string< C > &str)
 
Result WriteCString (const char *str)
 
Result WriteEnsureAlignmentPadding (const size_t align, size_t &out_pad_size)
 
Result WriteEnsureAlignment (const size_t align)
 
template<typename T>
Result WriteVector (const std::vector< T > &vec)
 
template<typename C>
Result WriteNullTerminatedString (const std::basic_string< C > &str)
 

Additional Inherited Members

- Protected Attributes inherited from twl::fs::File
FileMode mode
 

Member Function Documentation

◆ CloseImpl()

Result twl::fs::BufferFile::CloseImpl ( )
overridevirtual

Implements twl::fs::File.

◆ GetOffsetImpl()

Result twl::fs::BufferFile::GetOffsetImpl ( size_t & out_offset)
inlineoverridevirtual

Implements twl::fs::File.

◆ GetSizeImpl()

Result twl::fs::BufferFile::GetSizeImpl ( size_t & out_size)
inlineoverridevirtual

Implements twl::fs::File.

◆ OpenImpl()

Result twl::fs::BufferFile::OpenImpl ( const FileMode mode)
overridevirtual

Implements twl::fs::File.

◆ ReadBufferImpl()

Result twl::fs::BufferFile::ReadBufferImpl ( void * read_buf,
const size_t read_size )
overridevirtual

Implements twl::fs::File.

◆ SetOffsetImpl()

Result twl::fs::BufferFile::SetOffsetImpl ( const size_t offset,
const Whence whence )
overridevirtual

Implements twl::fs::File.

◆ WriteBufferImpl()

Result twl::fs::BufferFile::WriteBufferImpl ( const void * write_buf,
const size_t write_size )
overridevirtual

Implements twl::fs::File.


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