Cogs.Core
Public Member Functions | Public Attributes | List of all members
Cogs::MMapBackedFileContents Struct Reference
Inheritance diagram for Cogs::MMapBackedFileContents:
Cogs::FileContents

Public Member Functions

 MMapBackedFileContents (const uint8_t *ptr, size_t size, const FileHandle::Ptr &file, const std::string &path, FileContentsHints hints)
 
Memory::MemoryBuffer take () override
 Take ownership of underlying memorybuffer if exists.
 
StringView origin () override
 
- Public Member Functions inherited from Cogs::FileContents
 FileContents (const uint8_t *ptr, size_t size, FileContentsHints hints)
 
 FileContents (const FileContents &)=delete
 
FileContentsoperator= (const FileContents &)=delete
 
Memory::MemoryBuffer takeCopy ()
 
constexpr const void * data () const
 Access to buffer data. Cast to actual type using static_cast<const MyType*>(..)
 
virtual Memory::MemoryBuffer take ()=0
 Take ownership of underlying memorybuffer if exists.
 
virtual StringView origin ()=0
 

Public Attributes

FileHandle::Ptr file
 
std::string path
 
- Public Attributes inherited from Cogs::FileContents
const uint8_t * ptr
 Start of buffer storing file data. Use.
 
size_t size
 Number of data bytes.
 
size_t mimeTypeHash = 0
 
FileContentsHints hints = FileContentsHints::None
 

Additional Inherited Members

- Public Types inherited from Cogs::FileContents
using Ptr = std::unique_ptr< FileContents >
 
using Callback = std::function< void(Ptr &&)>
 

Detailed Description

Definition at line 9 of file MMapBackedFileContents.h.

Constructor & Destructor Documentation

◆ MMapBackedFileContents()

Cogs::MMapBackedFileContents::MMapBackedFileContents ( const uint8_t *  ptr,
size_t  size,
const FileHandle::Ptr &  file,
const std::string &  path,
FileContentsHints  hints 
)
inline

Definition at line 13 of file MMapBackedFileContents.h.

Member Function Documentation

◆ origin()

StringView Cogs::MMapBackedFileContents::origin ( )
inlineoverridevirtual

Implements Cogs::FileContents.

Definition at line 22 of file MMapBackedFileContents.h.

◆ take()

Memory::MemoryBuffer Cogs::MMapBackedFileContents::take ( )
inlineoverridevirtual

Take ownership of underlying memorybuffer if exists.

Implements Cogs::FileContents.

Definition at line 21 of file MMapBackedFileContents.h.

Member Data Documentation

◆ file

FileHandle::Ptr Cogs::MMapBackedFileContents::file

Definition at line 10 of file MMapBackedFileContents.h.

◆ path

std::string Cogs::MMapBackedFileContents::path

Definition at line 11 of file MMapBackedFileContents.h.


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