CeresEngine 0.2.0
A game development framework
Loading...
Searching...
No Matches
CeresEngine::LinuxFileSystem Class Referencefinal

Representation of the local file system on Linux. More...

#include <CeresEngine/Platform/Linux/LinuxFileSystem.hpp>

Inheritance diagram for CeresEngine::LinuxFileSystem:
CeresEngine::POSIXFileSystem CeresEngine::LocalFileSystem CeresEngine::IFileSystem CeresEngine::RefCounted< IFileSystem >

Public Member Functions

 LinuxFileSystem ()
 Creates a new LinuxFileSystem instance.
 
 ~LinuxFileSystem () final
 Destroys the LinuxFileSystem instance.
 
FileWatcher createFileWatcher () final
 Watches a directory for changes.
 
- Public Member Functions inherited from CeresEngine::POSIXFileSystem
 POSIXFileSystem ()
 
virtual ~POSIXFileSystem ()
 
virtual FileHandle open (StringView path) override
 
virtual FileHandle open (String &&path) override
 
- Public Member Functions inherited from CeresEngine::LocalFileSystem
 LocalFileSystem ()
 
virtual ~LocalFileSystem ()
 
FileWatcher createFileWatcher (ExecutionContext &executionContext, const FileHandle &directory, const FileEvents &events=FileEvent::Default, bool recursive=true) override
 Watches a directory for changes.
 
- Public Member Functions inherited from CeresEngine::IFileSystem
 IFileSystem ()
 
virtual ~IFileSystem ()
 
FileHandle open (const char *path)
 Opens a file or directory in file system.
 
- Public Member Functions inherited from CeresEngine::RefCounted< IFileSystem >
 RefCounted (Args &&... args)
 Creates a new RefCounted object and constructs a new Deleter by forwarding Args to it.
 
void retain () noexcept
 Retains the object by increment it's reference count by one.
 
bool release () noexcept
 Relases the object by decrementing it's reference count by one.
 

Additional Inherited Members

- Static Public Member Functions inherited from CeresEngine::IFileSystem
static IFileSystemgetLocal () noexcept
 Gets the underlying platform local file system implementation.
 

Detailed Description

Representation of the local file system on Linux.

Constructor & Destructor Documentation

◆ LinuxFileSystem()

CeresEngine::LinuxFileSystem::LinuxFileSystem ( )

Creates a new LinuxFileSystem instance.

◆ ~LinuxFileSystem()

CeresEngine::LinuxFileSystem::~LinuxFileSystem ( )
final

Destroys the LinuxFileSystem instance.

Member Function Documentation

◆ createFileWatcher()

FileWatcher CeresEngine::LinuxFileSystem::createFileWatcher ( )
final

Watches a directory for changes.

Note
The file handle must belong to the same file system as the file watcher, otherwise it will be ignored. Therefore, one file watcher object can only be used to watch files on a single file system. Also note that file watching may not supported for some file systems.
Parameters
executionContextThe execution context where the callbacks will be called from.
directoryA handle to directory that shall be watched.
eventsThe events that are watched (combination of FileEvent values).
recursiveDetermines whether the directory will be recursively watched.

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