oa::Filesystem

— stateless host-filesystem operations. oa::Path owns lexical path manipulation. oa::Paths owns OA location discovery.

ClC++ public headers

Static Public Methods

static oa::Result<oa::Path> oa::Filesystem::absolute(const oa::Path & inPath)

static oa::Status oa::Filesystem::appendText(const oa::Path & inPath, oa::StringView inContent)

static oa::Status oa::Filesystem::copy(const oa::Path & inFrom, const oa::Path & inTo)

static oa::Status oa::Filesystem::createDirectories(const oa::Path & inPath)

static oa::Status oa::Filesystem::createDirectory(const oa::Path & inPath)

static bool oa::Filesystem::exists(const oa::Path & inPath)

static oa::Result<oa::Usize> oa::Filesystem::getFileSize(const oa::Path & inPath)

static oa::Result<oa::I64> oa::Filesystem::getLastModified(const oa::Path & inPath)

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::glob(const oa::Path & inDir, oa::StringView inPattern)

static bool oa::Filesystem::isDirectory(const oa::Path & inPath)

static bool oa::Filesystem::isFile(const oa::Path & inPath)

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::listAll(const oa::Path & inDir, bool inRecursive = false)

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::listDirectories(const oa::Path & inDir)

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::listFiles(const oa::Path & inDir, oa::StringView inExtension = "")

static oa::Status oa::Filesystem::move(const oa::Path & inFrom, const oa::Path & inTo)

static oa::Result<oa::Vector<oa::U8>> oa::Filesystem::readBinary(const oa::Path & inPath)

static oa::Result<oa::Vector<oa::String>> oa::Filesystem::readLines(const oa::Path & inPath)

static oa::Result<oa::Vector<T>> oa::Filesystem::readPod(const oa::Path & inPath)

static oa::Result<oa::String> oa::Filesystem::readText(const oa::Path & inPath)

static oa::Status oa::Filesystem::removeDirectory(const oa::Path & inPath, bool inRecursive = false)

static oa::Status oa::Filesystem::removeFile(const oa::Path & inPath)

static oa::Status oa::Filesystem::writeBinary(const oa::Path & inPath, oa::Span<const oa::U8> inData)

static oa::Status oa::Filesystem::writePod(const oa::Path & inPath, oa::Span<const T> inData)

static oa::Status oa::Filesystem::writeText(const oa::Path & inPath, oa::StringView inContent)

Public Method Documentation

static oa::Result<oa::Path> oa::Filesystem::absolute(
	const oa::Path & inPath
)

─── Filesystem Resolution ────────────────────────────────────────────

Parameters

inPath

const oa::Path &

—

Returns

oa::Result<oa::Path>

The declared return value.

static oa::Status oa::Filesystem::appendText(
	const oa::Path & inPath,
	oa::StringView inContent
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

inContent

oa::StringView

—

Returns

oa::Status

The declared return value.

static oa::Status oa::Filesystem::copy(
	const oa::Path & inFrom,
	const oa::Path & inTo
)

No public source comment is attached to this declaration.

Parameters

inFrom

const oa::Path &

—

inTo

const oa::Path &

—

Returns

oa::Status

The declared return value.

static oa::Status oa::Filesystem::createDirectories(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

oa::Status

The declared return value.

static oa::Status oa::Filesystem::createDirectory(
	const oa::Path & inPath
)

─── directory operations ─────────────────────────────────────────────

Parameters

inPath

const oa::Path &

—

Returns

oa::Status

The declared return value.

static bool oa::Filesystem::exists(
	const oa::Path & inPath
)

─── Existence & Info ─────────────────────────────────────────────────

Parameters

inPath

const oa::Path &

—

Returns

bool

The declared return value.

static oa::Result<oa::Usize> oa::Filesystem::getFileSize(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

oa::Result<oa::Usize>

The declared return value.

static oa::Result<oa::I64> oa::Filesystem::getLastModified(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

oa::Result<oa::I64>

The declared return value.

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::glob(
	const oa::Path & inDir,
	oa::StringView inPattern
)

─── Glob Pattern Matching ────────────────────────────────────────────

Parameters

inDir

const oa::Path &

—

inPattern

oa::StringView

—

Returns

oa::Result<oa::Vector<oa::Path>>

The declared return value.

static bool oa::Filesystem::isDirectory(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

bool

The declared return value.

static bool oa::Filesystem::isFile(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

bool

The declared return value.

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::listAll(
	const oa::Path & inDir,
	bool inRecursive = false
)

No public source comment is attached to this declaration.

Parameters

inDir

const oa::Path &

—

inRecursive

bool

Default: false

Returns

oa::Result<oa::Vector<oa::Path>>

The declared return value.

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::listDirectories(
	const oa::Path & inDir
)

No public source comment is attached to this declaration.

Parameters

inDir

const oa::Path &

—

Returns

oa::Result<oa::Vector<oa::Path>>

The declared return value.

static oa::Result<oa::Vector<oa::Path>> oa::Filesystem::listFiles(
	const oa::Path & inDir,
	oa::StringView inExtension = ""
)

─── Listing ──────────────────────────────────────────────────────────

Parameters

inDir

const oa::Path &

—

inExtension

oa::StringView

Default: ""

Returns

oa::Result<oa::Vector<oa::Path>>

The declared return value.

static oa::Status oa::Filesystem::move(
	const oa::Path & inFrom,
	const oa::Path & inTo
)

No public source comment is attached to this declaration.

Parameters

inFrom

const oa::Path &

—

inTo

const oa::Path &

—

Returns

oa::Status

The declared return value.

static oa::Result<oa::Vector<oa::U8>> oa::Filesystem::readBinary(
	const oa::Path & inPath
)

─── Binary file operations ───────────────────────────────────────────

Parameters

inPath

const oa::Path &

—

Returns

oa::Result<oa::Vector<oa::U8>>

The declared return value.

static oa::Result<oa::Vector<oa::String>> oa::Filesystem::readLines(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

oa::Result<oa::Vector<oa::String>>

The declared return value.

static oa::Result<oa::Vector<T>> oa::Filesystem::readPod(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

oa::Result<oa::Vector<T>>

The declared return value.

static oa::Result<oa::String> oa::Filesystem::readText(
	const oa::Path & inPath
)

─── text file operations ─────────────────────────────────────────────

Parameters

inPath

const oa::Path &

—

Returns

oa::Result<oa::String>

The declared return value.

static oa::Status oa::Filesystem::removeDirectory(
	const oa::Path & inPath,
	bool inRecursive = false
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

inRecursive

bool

Default: false

Returns

oa::Status

The declared return value.

static oa::Status oa::Filesystem::removeFile(
	const oa::Path & inPath
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

Returns

oa::Status

The declared return value.

static oa::Status oa::Filesystem::writeBinary(
	const oa::Path & inPath,
	oa::Span<const oa::U8> inData
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

inData

oa::Span<const oa::U8>

—

Returns

oa::Status

The declared return value.

static oa::Status oa::Filesystem::writePod(
	const oa::Path & inPath,
	oa::Span<const T> inData
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

inData

oa::Span<const T>

—

Returns

oa::Status

The declared return value.

static oa::Status oa::Filesystem::writeText(
	const oa::Path & inPath,
	oa::StringView inContent
)

No public source comment is attached to this declaration.

Parameters

inPath

const oa::Path &

—

inContent

oa::StringView

—

Returns

oa::Status

The declared return value.