ove::fs Namespace Reference

Thin C++ wrappers around the oveRTOS filesystem utility functions. More...

Functions
Result< void >	mount (const char *dev_path, const char *mount_point) noexcept
	Mounts a filesystem at the given mount point.
void	unmount (const char *mount_point)
	Unmounts a previously mounted filesystem.
Result< void >	unlink (const char *path) noexcept
	Deletes a file from the filesystem.
Result< void >	rename (const char *old_path, const char *new_path) noexcept
	Renames or moves a file or directory.

Detailed Description

Thin C++ wrappers around the oveRTOS filesystem utility functions.

Available when CONFIG_OVE_FS is enabled. File and directory I/O is handled by the File and Dir RAII classes below.

Function Documentation

mount()

Result< void > ove::fs::mount ( const char *  dev_path, const char *  mount_point  )

inlinenoexcept

Mounts a filesystem at the given mount point.

Parameters

[in]	dev_path	Path to the block device or image file.
[in]	mount_point	Directory path at which to mount the filesystem.

Returns

Empty Result<void> on success; unexpected Error on failure.

unmount()

void ove::fs::unmount ( const char *  mount_point )

inline

Unmounts a previously mounted filesystem.

Parameters

[in]

mount_point

The mount point path passed to mount().

unlink()

Result< void > ove::fs::unlink ( const char *  path )

inlinenoexcept

Deletes a file from the filesystem.

Parameters

[in]

path

Absolute path to the file.

Returns

Empty Result<void> on success; unexpected Error on failure (Error::NotFound, …).

rename()

Result< void > ove::fs::rename ( const char *  old_path, const char *  new_path  )

inlinenoexcept

Renames or moves a file or directory.

Parameters

[in]	old_path	Current path of the file or directory.
[in]	new_path	Desired new path.

Returns

Empty Result<void> on success; unexpected Error on failure.