/usr/include/ncbi-vdb/kfs/file-v1.h is in libncbi-vdb-dev 2.8.1+dfsg-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 | /*===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's official duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================
*
*/
#ifndef _h_kfs_file_v1_
#define _h_kfs_file_v1_
#ifndef _h_kfs_extern_
#include <kfs/extern.h>
#endif
#ifndef _h_klib_defs_
#include <klib/defs.h>
#endif
#ifndef _h_klib_namelist_
#include <klib/namelist.h>
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*--------------------------------------------------------------------------
* forwards
*/
struct timeout_t;
/*--------------------------------------------------------------------------
* KFile_v1
* a file is normally created with a KDirectory
* optionally, the standard i/o files may be created directly
*/
typedef struct KFile_v1 KFile_v1;
/* AddRef
* Release
* ignores NULL references
*/
KFS_EXTERN rc_t CC KFileAddRef_v1 ( const KFile_v1 *self );
KFS_EXTERN rc_t CC KFileRelease_v1 ( const KFile_v1 *self );
/* RandomAccess
* ALMOST by definition, the file is random access
*
* certain file types will refuse random access
* these include FIFO and socket based files, but also
* wrappers that require serial access ( e.g. compression )
*
* returns 0 if random access, error code otherwise
*/
KFS_EXTERN rc_t CC KFileRandomAccess_v1 ( const KFile_v1 *self );
/* Type
* returns a KFileDesc
* not intended to be a content type,
* but rather an implementation class
*/
KFS_EXTERN uint32_t CC KFileType_v1 ( const KFile_v1 *self );
/* Size
* returns size in bytes of file
*
* "size" [ OUT ] - return parameter for file size
*/
KFS_EXTERN rc_t CC KFileSize_v1 ( const KFile_v1 *self, uint64_t *size );
/* SetSize
* sets size in bytes of file
*
* "size" [ IN ] - new file size
*/
KFS_EXTERN rc_t CC KFileSetSize_v1 ( KFile_v1 *self, uint64_t size );
/* Read
* TimedRead
* read file from known position
*
* "pos" [ IN ] - starting position within file
*
* "buffer" [ OUT ] and "bsize" [ IN ] - return buffer for read
*
* "num_read" [ OUT ] - return parameter giving number of bytes
* actually read. when returned value is zero and return code is
* also zero, interpreted as end of file.
*
* "tm" [ IN/OUT, NULL OKAY ] - an optional indicator of
* blocking behavior. not all implementations will support
* timed reads. a NULL timeout will block indefinitely,
* a value of "tm->mS == 0" will have non-blocking behavior
* if supported by implementation, and "tm->mS > 0" will indicate
* a maximum wait timeout.
*/
KFS_EXTERN rc_t CC KFileRead_v1 ( const KFile_v1 *self, uint64_t pos,
void *buffer, size_t bsize, size_t *num_read );
KFS_EXTERN rc_t CC KFileTimedRead_v1 ( const KFile_v1 *self, uint64_t pos,
void *buffer, size_t bsize, size_t *num_read, struct timeout_t *tm );
/* ReadAll
* TimedReadAll
* read from file until "bsize" bytes have been retrieved
* or until end-of-input
*
* "pos" [ IN ] - starting position within file
*
* "buffer" [ OUT ] and "bsize" [ IN ] - return buffer for read
*
* "num_read" [ OUT ] - return parameter giving number of bytes
* actually read. when returned value is zero and return code is
* also zero, interpreted as end of file.
*
* "tm" [ IN/OUT, NULL OKAY ] - an optional indicator of
* blocking behavior. not all implementations will support
* timed reads. a NULL timeout will block indefinitely,
* a value of "tm->mS == 0" will have non-blocking behavior
* if supported by implementation, and "tm->mS > 0" will indicate
* a maximum wait timeout.
*/
KFS_EXTERN rc_t CC KFileReadAll_v1 ( const KFile_v1 *self, uint64_t pos,
void *buffer, size_t bsize, size_t *num_read );
KFS_EXTERN rc_t CC KFileTimedReadAll_v1 ( const KFile_v1 *self, uint64_t pos,
void *buffer, size_t bsize, size_t *num_read, struct timeout_t *tm );
/* ReadExactly
* TimedReadExactly
* read from file until "bytes" have been retrieved
* or return incomplete transfer error
*
* "pos" [ IN ] - starting position within file
*
* "buffer" [ OUT ] and "bytes" [ IN ] - return buffer for read
*
* "tm" [ IN/OUT, NULL OKAY ] - an optional indicator of
* blocking behavior. not all implementations will support
* timed reads. a NULL timeout will block indefinitely,
* a value of "tm->mS == 0" will have non-blocking behavior
* if supported by implementation, and "tm->mS > 0" will indicate
* a maximum wait timeout.
*/
KFS_EXTERN rc_t CC KFileReadExactly_v1 ( const KFile_v1 *self,
uint64_t pos, void *buffer, size_t bytes );
KFS_EXTERN rc_t CC KFileTimedReadExactly_v1 ( const KFile_v1 *self,
uint64_t pos, void *buffer, size_t bytes, struct timeout_t *tm );
/* Write
* TimedWrite
* write file at known position
*
* "pos" [ IN ] - starting position within file
*
* "buffer" [ IN ] and "size" [ IN ] - data to be written
*
* "num_writ" [ OUT, NULL OKAY ] - optional return parameter
* giving number of bytes actually written
*
* "tm" [ IN/OUT, NULL OKAY ] - an optional indicator of
* blocking behavior. not all implementations will support
* timed writes. a NULL timeout will block indefinitely,
* a value of "tm->mS == 0" will have non-blocking behavior
* if supported by implementation, and "tm->mS > 0" will indicate
* a maximum wait timeout.
*/
KFS_EXTERN rc_t CC KFileWrite_v1 ( KFile_v1 *self, uint64_t pos,
const void *buffer, size_t size, size_t *num_writ );
KFS_EXTERN rc_t CC KFileTimedWrite_v1 ( KFile_v1 *self, uint64_t pos,
const void *buffer, size_t size, size_t *num_writ, struct timeout_t *tm );
/* WriteAll
* TimedWriteAll
* write to file until "size" bytes have been transferred
* or until no further progress can be made
*
* "pos" [ IN ] - starting position within file
*
* "buffer" [ IN ] and "size" [ IN ] - data to be written
*
* "num_writ" [ OUT, NULL OKAY ] - optional return parameter
* giving number of bytes actually written
*
* "tm" [ IN/OUT, NULL OKAY ] - an optional indicator of
* blocking behavior. not all implementations will support
* timed writes. a NULL timeout will block indefinitely,
* a value of "tm->mS == 0" will have non-blocking behavior
* if supported by implementation, and "tm->mS > 0" will indicate
* a maximum wait timeout.
*/
KFS_EXTERN rc_t CC KFileWriteAll_v1 ( KFile_v1 *self, uint64_t pos,
const void *buffer, size_t size, size_t *num_writ );
KFS_EXTERN rc_t CC KFileTimedWriteAll_v1 ( KFile_v1 *self, uint64_t pos,
const void *buffer, size_t size, size_t *num_writ, struct timeout_t *tm );
/* WriteExactly
* TimedWriteExactly
* write to file until "bytes" have been transferred
* or return incomplete transfer error
*
* "pos" [ IN ] - starting position within file
*
* "buffer" [ IN ] and "bytes" [ IN ] - data to be written
*
* "tm" [ IN/OUT, NULL OKAY ] - an optional indicator of
* blocking behavior. not all implementations will support
* timed writes. a NULL timeout will block indefinitely,
* a value of "tm->mS == 0" will have non-blocking behavior
* if supported by implementation, and "tm->mS > 0" will indicate
* a maximum wait timeout.
*/
KFS_EXTERN rc_t CC KFileWriteExactly_v1 ( KFile_v1 *self,
uint64_t pos, const void *buffer, size_t bytes );
KFS_EXTERN rc_t CC KFileTimedWriteExactly_v1 ( KFile_v1 *self,
uint64_t pos, const void *buffer, size_t bytes, struct timeout_t *tm );
/* MakeStdIn
* creates a read-only file on stdin
*/
KFS_EXTERN rc_t CC KFileMakeStdIn_v1 ( const KFile_v1 **std_in );
/* MakeStdOut
* MakeStdErr
* creates a write-only file on stdout or stderr
*/
KFS_EXTERN rc_t CC KFileMakeStdOut_v1 ( KFile_v1 **std_out );
KFS_EXTERN rc_t CC KFileMakeStdErr_v1 ( KFile_v1 **std_err );
#ifdef __cplusplus
}
#endif
#endif /* _h_kfs_file_v1_ */
|