Sane C++ Libraries
C++ Platform Abstraction Libraries
SC::FileSystemWatcher::Notification Struct Reference

Notification holding type and path. More...

#include <FileSystemWatcher.h>

Public Member Functions

SC::Result getFullPath (String &bufferString, StringView &outFullPath) const
 Get the full path of the file being watched. More...
 

Public Attributes

StringView basePath
 Reference to the watched directory. More...
 
StringView relativePath
 Relative path of the file being notified from basePath More...
 
Operation operation = Operation::Modified
 Notification type. More...
 

Friends

struct Internal
 

Detailed Description

Notification holding type and path.

Member Function Documentation

◆ getFullPath()

SC::Result SC::FileSystemWatcher::Notification::getFullPath ( String bufferString,
StringView outFullPath 
) const

Get the full path of the file being watched.

Parameters
[in]bufferStringOn some platform a String to hold the joined full path is needed.
[out]outFullPathThe full path
Returns
Invalid result if it's not possible building the full path

Member Data Documentation

◆ basePath

StringView SC::FileSystemWatcher::Notification::basePath

Reference to the watched directory.

◆ operation

Operation SC::FileSystemWatcher::Notification::operation = Operation::Modified

Notification type.

◆ relativePath

StringView SC::FileSystemWatcher::Notification::relativePath

Relative path of the file being notified from basePath


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