Skip to content

ludus::foundation::filesystem::WatchHint

Ludus Wiki · API overview · Browse API

Struct

Owned hint value; it does not hold a file revision or reference watcher storage.

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

#include <ludus/foundation/filesystem/watch.hpp>
struct ludus::foundation::filesystem::WatchHint final

Fields

Kind

WatchHintKind ludus::foundation::filesystem::WatchHint::Kind = WatchHintKind::Changed
Notification or rescan purpose.

Related types: WatchHintKind

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

Handle

WatchHandle ludus::foundation::filesystem::WatchHint::Handle
Registration; empty for a global RescanRequired hint.

Related types: WatchHandle

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

Tag

uint64 ludus::foundation::filesystem::WatchHint::Tag = 0
Host tag supplied at registration; zero for a global hint.

Related types: uint64

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

Observation

Result ludus::foundation::filesystem::WatchHint::Observation
Ok for a regular file, NotFound for absence, or a typed error.

Related types: Result

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

Stamp

FileStamp ludus::foundation::filesystem::WatchHint::Stamp
Metadata only when Observation is Ok.

Related types: FileStamp

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

Path

char ludus::foundation::filesystem::WatchHint::Path[MAX_PATH_BYTES+1][MAX_PATH_BYTES+1] {}
Validated relative UTF-8 path, terminated.

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

PathBytes

usize ludus::foundation::filesystem::WatchHint::PathBytes = 0
Encoded path length, excluding the terminator.

Related types: usize

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp

Methods

PathView

std::string_view ludus::foundation::filesystem::WatchHint::PathView() const noexcept
Returns the owned path view, valid for this hint's lifetime.

Declared in modules/foundation/filesystem/include/ludus/foundation/filesystem/watch.hpp