Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
Classes | Enumerations | Functions
FileSystem Watcher

🟩 Portable, recursive directory-change notifications for files and directories (see File System Watcher for more details) More...

Classes

struct  SC::FileSystemWatcher
 Notifies about events (add, remove, rename, modified) on files and directories. More...
 
struct  SC::FileSystemWatcherAsyncT< T_AsyncEventLoop >
 FileSystemWatcherAsyncT is an implementation of SC::FileSystemWatcher that uses SC::Async. More...
 
struct  SC::ResultFileSystemWatcher
 FileSystemWatcher result retaining backend-stage and native-error context. More...
 

Enumerations

enum class  SC::FileSystemWatcherError : uint32_t {
  NotInitialized = 1 ,
  AlreadyWatching ,
  NotWatching ,
  UnsupportedPathEncoding ,
  PathPreparationFailed ,
  WatchLimitExceeded ,
  BufferTooSmall ,
  InitializationFailed ,
  WatchSetupFailed ,
  StopWatchingFailed ,
  CloseFailed
}
 Stable portable failures returned by the FileSystemWatcher library. More...
 
enum class  SC::FileSystemWatcherErrorDetail : uint32_t {
  None = 0 ,
  AssignWatchPath ,
  BuildSubfolderPath ,
  BuildNotificationPath ,
  BuildFullPath ,
  WatchPathCapacity ,
  WorkerAlreadyStarted ,
  PosixPthreadCreate ,
  PosixPthreadJoin ,
  WindowsCreateThread ,
  WindowsWaitForSingleObject ,
  LinuxCreateShutdownPipe ,
  LinuxInitializeInotify ,
  LinuxWriteShutdownPipe ,
  LinuxInotifyDescriptor ,
  LinuxRemoveWatch ,
  LinuxAddRootWatch ,
  LinuxAddSubdirectoryWatch ,
  LinuxOpenRootDirectory ,
  LinuxWatchHandleCapacity ,
  LinuxPendingDirectoryCapacity ,
  LinuxRelativePathStorage ,
  AppleRunLoop ,
  AppleCreateRunLoopSource ,
  AppleAllocateWatchPaths ,
  AppleCreateWatchPathString ,
  AppleCreateWatchPathsArray ,
  AppleCreateEventStream ,
  AppleStartEventStream ,
  WindowsOpenDirectory ,
  WindowsSubmitDirectoryChanges
}
 Stable backend stages retained as context for a FileSystemWatcher failure. More...
 

Functions

ResultErrorFormat SC::formatFileSystemWatcherError (FileSystemWatcherError error, Span< char > output)
 
ResultErrorFormat SC::formatFileSystemWatcherError (Result result, Span< char > output)
 
ResultErrorFormat SC::formatFileSystemWatcherError (ResultFileSystemWatcher result, Span< char > output)
 

Detailed Description

🟩 Portable, recursive directory-change notifications for files and directories (see File System Watcher for more details)

Enumeration Type Documentation

◆ FileSystemWatcherError

enum class SC::FileSystemWatcherError : uint32_t
strong

#include <FileSystemWatcherError.h>

Stable portable failures returned by the FileSystemWatcher library.

◆ FileSystemWatcherErrorDetail

enum class SC::FileSystemWatcherErrorDetail : uint32_t
strong

#include <FileSystemWatcherError.h>

Stable backend stages retained as context for a FileSystemWatcher failure.