Sane C++ Libraries
C++ Platform Abstraction Libraries
Loading...
Searching...
No Matches
Classes | Enumerations
File

🟩 Synchronous Disk File I/O (see File for more details) More...

Classes

struct  SC::FileDescriptorStat
 A structure to describe file stats queried through a file descriptor. More...
 
struct  SC::FileOpen
 Options used to open a file descriptor. More...
 
struct  SC::FileDescriptor
 [UniqueHandleDeclaration2Snippet] More...
 
struct  SC::PipeOptions
 
struct  SC::PipeDescriptor
 Read / Write pipe (Process stdin/stdout and IPC communication) More...
 
struct  SC::NamedPipeNameOptions
 
struct  SC::NamedPipeName
 Utility for building platform-native named pipe endpoint names from logical names. More...
 
struct  SC::NamedPipeServerOptions
 
struct  SC::NamedPipeClientOptions
 
struct  SC::NamedPipeServer
 Named pipe server endpoint. More...
 
struct  SC::NamedPipeClient
 Named pipe client endpoint creator. More...
 
union  SC::FileErrorContext
 Typed scalar payload for a File error. More...
 
struct  SC::ResultFile
 File result retaining an operation detail and one scalar diagnostic context. More...
 

Enumerations

enum class  SC::FileDescriptorEntryType : uint8_t {
  Unknown ,
  File ,
  Directory ,
  SymbolicLink ,
  Other
}
 A structure to describe metadata associated with an open descriptor. More...
 
enum class  SC::FileError : uint32_t {
  InvalidHandle = 1 ,
  UnsupportedPathEncoding ,
  InvalidPath ,
  PathMustBeAbsolute ,
  PathCapacityExceeded ,
  InvalidNamedPipeName ,
  InvalidState ,
  OperationUnsupported ,
  OpenFailed ,
  CloseFailed ,
  ReadFailed ,
  WriteFailed ,
  IncompleteWrite ,
  SeekFailed ,
  MetadataQueryFailed ,
  PermissionsChangeFailed ,
  OwnershipChangeFailed ,
  SyncFailed ,
  TruncateFailed ,
  DuplicateFailed ,
  DescriptorConfigurationFailed ,
  PipeCreationFailed ,
  NamedPipeCreationFailed ,
  NamedPipeConnectionFailed ,
  NamedPipeAcceptFailed ,
  EndpointCleanupFailed ,
  BufferCapacityExceeded ,
  WouldBlock ,
  TimedOut ,
  OperationCancelled ,
  PipeDisconnected
}
 Stable portable failures returned by the File library. More...
 
enum class  SC::FileErrorDetail : uint16_t {
  None = 0 ,
  ValidatePathEncoding ,
  NormalizePath ,
  ValidateAbsolutePath ,
  BuildTransportPath ,
  OpenFile ,
  CloseDescriptor ,
  ReadDescriptor ,
  ReadDescriptorAtOffset ,
  GrowReadBuffer ,
  ResetReadBuffer ,
  WriteDescriptor ,
  WriteDescriptorAtOffset ,
  SeekDescriptor ,
  QueryDescriptorPosition ,
  QueryDescriptorSize ,
  QueryDescriptorMetadata ,
  ChangeDescriptorPermissions ,
  ChangeDescriptorOwnership ,
  SynchronizeDescriptor ,
  SynchronizeDescriptorData ,
  TruncateDescriptor ,
  GetStandardHandle ,
  DuplicateStandardHandle ,
  CreateAnonymousPipe ,
  DuplicatePipeDescriptor ,
  AssignPipeDescriptor ,
  QueryDescriptorFlags ,
  ConfigureDescriptorFlags ,
  ValidateNamedPipeLogicalName ,
  BuildNamedPipePath ,
  ValidateNamedPipePath ,
  CreateNamedPipeServer ,
  RemoveNamedPipeEndpoint ,
  BindNamedPipeServer ,
  ListenNamedPipeServer ,
  AcceptNamedPipeConnection ,
  WaitNamedPipeClient ,
  ConnectNamedPipeClient ,
  DuplicateNamedPipeConnection
}
 Stable logical operation or native backend stage retained for a File failure. More...
 
enum class  SC::FileErrorContextKind : uint16_t {
  None = 0 ,
  NativeError ,
  RequiredBytes ,
  ActualBytes
}
 Kind of scalar diagnostic context stored in ResultFile. More...
 

Detailed Description

🟩 Synchronous Disk File I/O (see File for more details)

Enumeration Type Documentation

◆ FileDescriptorEntryType

enum class SC::FileDescriptorEntryType : uint8_t
strong

#include <File.h>

A structure to describe metadata associated with an open descriptor.

◆ FileError

enum class SC::FileError : uint32_t
strong

#include <FileError.h>

Stable portable failures returned by the File library.

◆ FileErrorContextKind

enum class SC::FileErrorContextKind : uint16_t
strong

#include <FileError.h>

Kind of scalar diagnostic context stored in ResultFile.

◆ FileErrorDetail

enum class SC::FileErrorDetail : uint16_t
strong

#include <FileError.h>

Stable logical operation or native backend stage retained for a File failure.