← API Reference Namespace

asge::filesystem

Namespaces

Classes & Structs

Enumerations

#enum class FEventType : std::uint8_t
None
Created
Deleted
Modified
Moved
All

Typedefs

#using Path = std::filesystem::path
#using FileSize = uintmax_t
#using FileTime = std::filesystem::file_time_type
#using FileType = std::filesystem::file_type
#using native_event_t = std::uint32_t
#using handle_t = std::int32_t
#using WatcherHandler = signals::Connection< FileEvent const & >
#using FileWatcher = _linux::FileWatcher

Functions

#Result< str::String > ReadText(Path const &inPath)

Reads the input file content into a string.

Parameters
inPath

The path of the file

#BoolResult WriteText(Path const &inPath, str::String const &inContent)

Writes (overwriting) the input content into the given file.

Parameters
inPath

The path of the file

inContent

The content to write

#BoolResult Copy(Path const &inSource, Path const &inDestination) noexcept

Copies (overwriting an existing destination) a file.

Parameters
inSource

The path of the file to copy from

inDestination

The path of the file to copy to

#Result< std::vector< std::byte > > ReadBinary(Path const &inPath)

Reads the entire contents of a file into memory as raw bytes.

Opens the file in binary mode (no text-mode newline translation), so it is safe for arbitrary binary data such as images, audio, or compressed assets. For text files, prefer ReadText instead.

Parameters
inPath

The path of the file to read.

#constexpr FEventType operator|(FEventType in1, FEventType in2) noexcept
#constexpr FEventType operator&(FEventType in1, FEventType in2) noexcept
#constexpr FEventType operator~(FEventType in1) noexcept
#FEventType & operator|=(FEventType &in1, FEventType in2) noexcept
#FEventType & operator&=(FEventType &in1, FEventType in2) noexcept
#std::ostream & operator<<(std::ostream &inOss, FEventType inMask) noexcept
#std::ostream & operator<<(std::ostream &inOss, const FileEvent &inEvent)