Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
SC::ResultFileSystemIterator Struct Reference

FileSystemIterator result retaining optional native, backend-stage, and directory-depth details. More...

#include <FileSystemIteratorError.h>

Public Member Functions

constexpr ResultFileSystemIterator (bool valid=true)
 
constexpr ResultFileSystemIterator (FileSystemIteratorError error, FileSystemIteratorErrorDetail detail=FileSystemIteratorErrorDetail::None, uint32_t nativeError=0, uint32_t depth=0)
 
constexpr ResultFileSystemIterator (Result result)
 
template<typename ResultLike >
constexpr ResultFileSystemIterator (const ResultLike &other)
 
constexpr operator bool () const
 
constexpr operator Result () const
 
constexpr Result toResult () const
 
constexpr bool isError (FileSystemIteratorError error) const
 

Public Attributes

Result result
 
uint32_t nativeError = 0
 
uint16_t depth = 0
 
FileSystemIteratorErrorDetail detail = FileSystemIteratorErrorDetail::None
 

Detailed Description

FileSystemIterator result retaining optional native, backend-stage, and directory-depth details.

nativeError is zero when unavailable. depth is the affected root-relative directory depth and detail is None when no lower-level stage is relevant. The path storage bounds successful traversal depth by StringPath::MaxPath, which is at most 65535 on supported platforms, so depth and detail can safely use 16 bits each. The type occupies 16 bytes. Converting to Result preserves the portable error identity and deliberately discards all context fields.


The documentation for this struct was generated from the following file: