IOStream.h

Go to the documentation of this file.

/*
 * SPDX-FileCopyrightText: Copyright (c) 2016-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 * SPDX-License-Identifier: LicenseRef-NvidiaProprietary
 *
 * NVIDIA CORPORATION, its affiliates and licensors retain all intellectual
 * property and proprietary rights in and to this material, related
 * documentation and any modifications thereto. Any use, reproduction,
 * disclosure or distribution of this material and related documentation
 * without an express license agreement from NVIDIA CORPORATION or
 * its affiliates is strictly prohibited.
 */
 
#ifndef DW_CORE_IOSTREAM_H_
#define DW_CORE_IOSTREAM_H_
 
#include <dw/core/base/Exports.h>
#include <dw/core/base/Types.h>
#include <dw/core/base/Status.h>
#include <dw/core/context/Context.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef enum dwIOStreamFlags {
    DW_IOSTREAM_READ           = 1 << 0, 
    DW_IOSTREAM_WRITE          = 1 << 1, 
    DW_IOSTREAM_APPEND         = 1 << 2, 
    DW_IOSTREAM_FORCE_BUFFERED = 1 << 3, 
} dwIOStreamFlags;
 
typedef struct dwIOStreamObject* dwIOStreamHandle_t;
 
DW_API_PUBLIC
dwStatus dwIOStream_openFile(dwIOStreamHandle_t* stream, const char8_t* path, uint64_t flags, dwContextHandle_t context);
 
DW_API_PUBLIC
dwStatus dwIOStream_wrapFileDescriptor(dwIOStreamHandle_t* stream, int posixFd);
 
// Reading, seeking and other interfaces intentionally omitted, as the goal of this API is not
// to provide a replacement for stdio to users, but to serve as a way to communicate how data is
// to be read to other DW APIs.
 
DW_API_PUBLIC
dwStatus dwIOStream_close(dwIOStreamHandle_t stream);
 
#ifdef __cplusplus
}
#endif
 
#endif