IOStream.h

Go to the documentation of this file.

 
//
// Notice
// ALL NVIDIA DESIGN SPECIFICATIONS AND CODE ("MATERIALS") ARE PROVIDED "AS IS" NVIDIA MAKES
// NO REPRESENTATIONS, WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO
// THE MATERIALS, AND EXPRESSLY DISCLAIMS ANY IMPLIED WARRANTIES OF NONINFRINGEMENT,
// MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
//
// NVIDIA CORPORATION & AFFILIATES assumes no responsibility for the consequences of use of such
// information or for any infringement of patents or other rights of third parties that may
// result from its use. No license is granted by implication or otherwise under any patent
// or patent rights of NVIDIA CORPORATION & AFFILIATES. No third party distribution is allowed unless
// expressly authorized by NVIDIA. Details are subject to change without notice.
// This code supersedes and replaces all information previously supplied.
// NVIDIA CORPORATION & AFFILIATES products are not authorized for use as critical
// components in life support devices or systems without express written approval of
// NVIDIA CORPORATION & AFFILIATES.
//
// SPDX-FileCopyrightText: Copyright (c) 2016-2023 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,
} 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