Sane C++ Libraries
C++ Platform Abstraction Libraries
All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Modules Pages
SC::FileSystemWatcher::Notification Struct Reference

Notification holding type and path. More...

#include <FileSystemWatcher.h>

Public Member Functions

SC::Result getFullPath (Span< native_char_t > bufferSpan, StringViewData &outFullPath) const
 Get the full path of the file being watched.
 

Public Attributes

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

Friends

struct Internal
 

Detailed Description

Notification holding type and path.

Member Function Documentation

◆ getFullPath()

SC::Result SC::FileSystemWatcher::Notification::getFullPath ( Span< native_char_t > bufferSpan,
StringViewData & outFullPath ) const

Get the full path of the file being watched.

Parameters
[in]bufferSpanSpace holding full path
[out]outFullPathThe full path
Returns
Invalid result if it's not possible building the full path

Member Data Documentation

◆ basePath

StringViewData SC::FileSystemWatcher::Notification::basePath

Reference to the watched directory.

◆ operation

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

Notification type.

◆ relativePath

StringViewData SC::FileSystemWatcher::Notification::relativePath

Relative path of the file being notified from basePath


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