arene::base::filesystem Namespace Reference

Typedef Documentation

error_string

using arene::base::filesystem::error_string = inline_string<max_error_length>

An inline_string large enough to hold an error message.

path_buffer

using arene::base::filesystem::path_buffer = array<arene::base::detail::character, PATH_MAX>

A raw buffer with storage large enough to hold a file path.

path_string

using arene::base::filesystem::path_string = inline_string<PATH_MAX>

An inline_string with storage large enough to hold a file path.

Enumeration Type Documentation

create_flags

enum class arene::base::filesystem::create_flags : std::uint8_t

strong

Flags to specify what to do when attempting to create a file that already exists.

Enumerator
create_or_fail	If the file already exists fail the creation.
create_or_truncate	If the file already exists, truncate it and open it.
create_or_open	If the file already exists, open the existing file without altering it.

open_flags

enum class arene::base::filesystem::open_flags : std::uint8_t

strong

An enumeration specifying choices for opening files.

Enumerator
read_only	Open in read-only mode.
read_write	Open in read-write mode.

Variable Documentation

max_error_length

std::size_t arene::base::filesystem::max_error_length {128U}

constexpr

The maximum length of an error message.