FileSystem

🟩 Synchronous, path-based file and directory operations (see File System for more details) More...

Classes
struct	SC::FileSystemStat
	A structure to describe file stats. More...
struct	SC::FileSystemCopyFlags
	A structure to describe copy flags. More...
struct	SC::FileSystem
	Execute fs operations { exists, copy, delete } for { files and directories }. More...
union	SC::FileSystemErrorContext
	Typed scalar payload for a FileSystem error. More...
struct	SC::ResultFileSystem
	FileSystem result retaining an operation detail and one scalar diagnostic context. More...
struct	SC::Path
	Parse and compose filesystem paths for windows and posix. More...

Enumerations
enum class	SC::FileSystemEntryType : uint8_t {   Unknown ,   File ,   Directory ,   SymbolicLink ,   Other }
	A structure to describe file stats. More...
enum class	SC::FileSystemAccessMode : uint8_t {   FileSystemAccessMode::Exists ,   FileSystemAccessMode::Read ,   FileSystemAccessMode::Write ,   FileSystemAccessMode::Execute }
	Access mode for path checks. More...
enum class	SC::FileSystemError : uint32_t {   NotInitialized = 1 ,   UnsupportedPathEncoding ,   InvalidPath ,   PathMustBeAbsolute ,   PathCapacityExceeded ,   InvalidState ,   EntryNotFound ,   EntryAlreadyExists ,   EntryTypeMismatch ,   AccessDenied ,   ReadOnlyFileSystem ,   StorageCapacityExceeded ,   DirectoryNotEmpty ,   TooManyLinks ,   SymbolicLinkLoop ,   CrossDeviceOperation ,   InvalidArgument ,   OperationUnsupported ,   OutOfMemory ,   BufferCapacityExceeded ,   FileTooLarge ,   IncompleteRead ,   IncompleteWrite ,   UnsupportedEntryType ,   IoFailure ,   OperationFailed }
	Stable portable failures returned by the FileSystem library. More...
enum class	SC::FileSystemErrorDetail : uint16_t {   None = 0 ,   ValidatePathEncoding ,   NormalizePath ,   ValidateAbsoluteBasePath ,   BuildTransportPath ,   ChangeDirectory ,   CheckAccess ,   QueryEntryMetadata ,   OpenFileForRead ,   OpenFileForWrite ,   QueryFileSize ,   GrowReadBuffer ,   ReadFileContent ,   WriteFileContent ,   AppendFileContent ,   CreateDirectoryEntry ,   CreateParentDirectory ,   RemoveFileEntry ,   RemoveDirectoryEntry ,   RenameEntry ,   CreateSymbolicLinkEntry ,   CreateHardLinkEntry ,   ReadSymbolicLinkTarget ,   StoreSymbolicLinkTarget ,   ChangePermissions ,   ChangeOwnership ,   ChangeLinkPermissions ,   ChangeLinkOwnership ,   ChangeModifiedTime ,   CopyFileEntry ,   CopyDirectoryTree ,   CloneEntry ,   OpenSourceFile ,   OpenDestinationFile ,   OpenSourceDirectory ,   EnumerateDirectory ,   BuildChildPath ,   QueryChildMetadata ,   CopyChildEntry ,   RemoveChildEntry ,   WindowsQueryReparsePoint ,   QueryFileTimes ,   SetFileTimes }
	Stable logical operation or backend stage retained for a FileSystem failure. More...
enum class	SC::FileSystemErrorContextKind : uint16_t {   None = 0 ,   NativeError ,   RequiredBytes ,   ActualBytes }
	Kind of scalar diagnostic context stored in ResultFileSystem. More...

Detailed Description

🟩 Synchronous, path-based file and directory operations (see File System for more details)

Enumeration Type Documentation

FileSystemAccessMode

enum class SC::FileSystemAccessMode : uint8_t

strong

#include <FileSystem.h>

Access mode for path checks.

Enumerator
Exists	Check if path exists.
Read	Check if path is readable.
Write	Check if path is writable.
Execute	Check if path is executable / traversable.

FileSystemEntryType

enum class SC::FileSystemEntryType : uint8_t

strong

#include <FileSystem.h>

A structure to describe file stats.

FileSystemError

enum class SC::FileSystemError : uint32_t

strong

#include <FileSystemError.h>

Stable portable failures returned by the FileSystem library.

FileSystemErrorContextKind

enum class SC::FileSystemErrorContextKind : uint16_t

strong

#include <FileSystemError.h>

Kind of scalar diagnostic context stored in ResultFileSystem.

FileSystemErrorDetail

enum class SC::FileSystemErrorDetail : uint16_t

strong

#include <FileSystemError.h>

Stable logical operation or backend stage retained for a FileSystem failure.