bdls.txt

@PURPOSE: Provide platform-independent system-level utilities.

@MNEMONIC: Basic Development Library System-level utilities (bdls)

@DESCRIPTION: The 'bdls' package provides a suite of components for
 platform-independent interactions with operating system for the management of
 memory, files, and pipes.

/Hierarchical Synopsis
/---------------------
 The 'bdls' package currently has 14 components having 4 levels of physical
 dependency.  The list below shows the hierarchical ordering of the components.
 The order of components within each level is not architecturally significant,
 just alphabetical.
..
  4. bdls_osutil
     bdls_pipeutil

  3. bdls_fdstreambuf
     bdls_filedescriptorguard
     bdls_processutil
     bdls_tempdirectoryguard

  2. bdls_filesystemutil

  1. bdls_filesystemutil_transitionaluniximputil                      !PRIVATE!
     bdls_filesystemutil_uniximputil                                  !PRIVATE!
     bdls_filesystemutil_unixplatform                                 !PRIVATE!
     bdls_filesystemutil_windowsimputil                               !PRIVATE!
     bdls_memoryutil
     bdls_pathutil
     bdls_testutil                                       !DEPRECATED!
..

/Component Synopsis
/------------------
: 'bdls_fdstreambuf':
:      Provide a stream buffer initialized with a file descriptor.
:
: 'bdls_filedescriptorguard':
:      Provide a RAII guard class used to close files.
:
: 'bdls_filesystemutil':
:      Provide methods for filesystem access with multi-language names.
:
: 'bdls_filesystemutil_transitionaluniximputil':                      !PRIVATE!
:      Provide testable 'bdls::FilesystemUtil' operations for some Unixes.
:
: 'bdls_filesystemutil_uniximputil':                                  !PRIVATE!
:      Provide testable 'bdls::FilesystemUtil' operations for some Unixes.
:
: 'bdls_filesystemutil_unixplatform':                                 !PRIVATE!
:      Provide Unix timstamp and offset type width detection macros.
:
: 'bdls_filesystemutil_windowsimputil':                               !PRIVATE!
:      Provide testable 'bdls::FilesystemUtil' operations on Windows.
:
: 'bdls_memoryutil':
:      Provide a set of portable utilities for memory manipulation.
:
: 'bdls_osutil':
:      Provide utilities related to the operating system.
:
: 'bdls_pathutil':
:      Provide portable file path manipulation.
:
: 'bdls_pipeutil':
:      Provide basic portable named-pipe utilities.
:
: 'bdls_processutil':
:      Provide basic platform-independent utilities related to processes.
:
: 'bdls_tempdirectoryguard':
:      Provide a scoped guard that creates a unique temporary directory.
:
: 'bdls_testutil':                                       !DEPRECATED!
:      Provide test utilities for components in 'bdl' and above.