Go to the documentation of this file.
32 #ifndef CPL_VSI_H_INCLUDED
33 #define CPL_VSI_H_INCLUDED
36 #include "cpl_progress.h"
73 #ifdef ENABLE_EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
74 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT CPL_WARN_UNUSED_RESULT
76 #define EXPERIMENTAL_CPL_WARN_UNUSED_RESULT
88 int CPL_DLL VSIFClose( FILE * );
89 int CPL_DLL VSIFSeek( FILE *,
long,
int ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
91 void CPL_DLL VSIRewind( FILE * );
92 void CPL_DLL VSIFFlush( FILE * );
94 size_t CPL_DLL VSIFRead(
void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
95 size_t CPL_DLL VSIFWrite(
const void *,
size_t,
size_t, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
96 char CPL_DLL *VSIFGets(
char *,
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
97 int CPL_DLL VSIFPuts(
const char *, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
100 int CPL_DLL VSIFGetc( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
101 int CPL_DLL VSIFPutc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
102 int CPL_DLL VSIUngetc(
int, FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
103 int CPL_DLL VSIFEof( FILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
112 typedef struct stat VSIStatBuf;
117 # define VSI_ISLNK(x) ( 0 )
118 # define VSI_ISREG(x) ((x) & S_IFREG)
119 # define VSI_ISDIR(x) ((x) & S_IFDIR)
120 # define VSI_ISCHR(x) ((x) & S_IFCHR)
121 # define VSI_ISBLK(x) ( 0 )
124 # define VSI_ISLNK(x) S_ISLNK(x)
126 # define VSI_ISREG(x) S_ISREG(x)
128 # define VSI_ISDIR(x) S_ISDIR(x)
130 # define VSI_ISCHR(x) S_ISCHR(x)
131 # define VSI_ISBLK(x) S_ISBLK(x)
144 #define VSI_L_OFFSET_MAX GUINTBIG_MAX
149 #define VSIL_STRICT_ENFORCE
153 #ifdef VSIL_STRICT_ENFORCE
168 size_t CPL_DLL
VSIFReadL(
void *,
size_t,
size_t,
VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
170 size_t CPL_DLL
VSIFWriteL(
const void *,
size_t,
size_t,
VSILFILE * ) EXPERIMENTAL_CPL_WARN_UNUSED_RESULT;
188 const char* pszFilename,
195 #if defined(VSI_STAT64_T)
200 #define VSIStatBufL VSIStatBuf
206 #define VSI_STAT_EXISTS_FLAG 0x1
208 #define VSI_STAT_NATURE_FLAG 0x2
210 #define VSI_STAT_SIZE_FLAG 0x4
212 #define VSI_STAT_SET_ERROR_FLAG 0x8
216 #define VSI_STAT_CACHE_ONLY 0x10
224 bool CPL_DLL
VSIIsLocal(
const char* pszPath );
247 const char* pszDomain,
251 const char* pszValue );
254 const char* pszDefault );
256 void CPL_DLL
VSISetCredential(
const char* pszPathPrefix,
const char* pszKey,
257 const char* pszValue )
259 CPL_WARN_DEPRECATED(
"Use VSISetPathSpecificOption instead")
264 CPL_WARN_DEPRECATED(
"Use VSIClearPathSpecificOptions instead")
267 const char CPL_DLL*
VSIGetCredential(
const char* pszPath,
const char* pszKey,
268 const char* pszDefault )
270 CPL_WARN_DEPRECATED(
"Use VSIGetPathSpecificOption instead")
280 void CPL_DLL
VSIFree(
void * );
290 #define VSI_MALLOC_ALIGNED_AUTO_VERBOSE( size ) VSIMallocAlignedAutoVerbose(size,__FILE__,__LINE__)
313 #define VSI_MALLOC_VERBOSE( size ) VSIMallocVerbose(size,__FILE__,__LINE__)
318 #define VSI_MALLOC2_VERBOSE( nSize1, nSize2 ) VSIMalloc2Verbose(nSize1,nSize2,__FILE__,__LINE__)
323 #define VSI_MALLOC3_VERBOSE( nSize1, nSize2, nSize3 ) VSIMalloc3Verbose(nSize1,nSize2,nSize3,__FILE__,__LINE__)
328 #define VSI_CALLOC_VERBOSE( nCount, nSize ) VSICallocVerbose(nCount,nSize,__FILE__,__LINE__)
333 #define VSI_REALLOC_VERBOSE( pOldPtr, nNewSize ) VSIReallocVerbose(pOldPtr,nNewSize,__FILE__,__LINE__)
338 #define VSI_STRDUP_VERBOSE( pszStr ) VSIStrdupVerbose(pszStr,__FILE__,__LINE__)
348 #define CPLReadDir VSIReadDir
351 char CPL_DLL **
VSIReadDirEx(
const char *pszPath,
int nMaxFiles );
359 const char*
const *papszOptions);
385 #if defined(__cplusplus) && !defined(CPL_SUPRESS_CPLUSPLUS)
398 int CPL_DLL
VSIMkdir(
const char * pszPathname,
long mode );
400 int CPL_DLL
VSIRmdir(
const char * pszDirname );
402 int CPL_DLL
VSIUnlink(
const char * pszFilename );
404 int CPL_DLL
VSIRename(
const char * oldpath,
const char * newpath );
405 int CPL_DLL
VSISync(
const char* pszSource,
const char* pszTarget,
406 const char*
const * papszOptions,
407 GDALProgressFunc pProgressFunc,
409 char*** ppapszOutputs );
423 void CPL_DLL VSIInstallLargeFileHandler(
void);
452 void CPL_DLL VSICleanupFileManager(
void);
461 int bUnlinkAndSeize );
464 typedef size_t (*
VSIWriteFunction)(
const void* ptr,
size_t size,
size_t nmemb, FILE* stream);
496 typedef char** (*VSIFilesystemPluginReadDirCallback) (
void *pUserData,
const char *pszDirname,
int nMaxFiles );
505 typedef char** (*VSIFilesystemPluginSiblingFilesCallback) (
void *pUserData,
const char *pszDirname );
511 typedef void* (*VSIFilesystemPluginOpenCallback) (
void *pUserData,
const char *pszFilename,
const char *pszAccess );
533 const vsi_l_offset* panOffsets,
const size_t* panSizes );
628 unsigned long CPL_DLL VSITime(
unsigned long * );
629 const char CPL_DLL *VSICTime(
unsigned long );
630 struct tm CPL_DLL *VSIGMTime(
const time_t *pnTime,
631 struct tm *poBrokenTime );
632 struct tm CPL_DLL *VSILocalTime(
const time_t *pnTime,
633 struct tm *poBrokenTime );
649 #define VSIDebug4(f,a1,a2,a3,a4) CPLDebug( "VSI", f, a1, a2, a3, a4 );
650 #define VSIDebug3( f, a1, a2, a3 ) CPLDebug( "VSI", f, a1, a2, a3 );
651 #define VSIDebug2( f, a1, a2 ) CPLDebug( "VSI", f, a1, a2 );
652 #define VSIDebug1( f, a1 ) CPLDebug( "VSI", f, a1 );
654 #define VSIDebug4( f, a1, a2, a3, a4 ) {}
655 #define VSIDebug3( f, a1, a2, a3 ) {}
656 #define VSIDebug2( f, a1, a2 ) {}
657 #define VSIDebug1( f, a1 ) {}
char bMTimeKnown
Whether nMTime is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:381
const VSIDIREntry * VSIGetNextDirEntry(VSIDIR *dir)
Return the next entry of the directory.
Definition: cpl_vsil.cpp:303
size_t nBufferSize
buffer small reads (makes handler read only)
Definition: cpl_vsi.h:593
VSIDIR * VSIOpenDir(const char *pszPath, int nRecurseDepth, const char *const *papszOptions)
Open a directory to read its entries.
Definition: cpl_vsil.cpp:266
int VSIOverwriteFile(VSILFILE *fpTarget, const char *pszSourceFilename)
Overwrite an existing file with content from another one.
Definition: cpl_vsil.cpp:2583
void VSIInstallSwiftFileHandler(void)
Install /vsiswift/ OpenStack Swif Object Storage (Swift) file system handler (requires libcurl)
Definition: cpl_vsil_swift.cpp:788
#define CPL_PRINT_FUNC_FORMAT(format_idx, arg_idx)
Tag a function to have printf() formatting.
Definition: cpl_port.h:844
@ VSI_RANGE_STATUS_HOLE
Hole.
Definition: cpl_vsi.h:182
VSIFilesystemPluginCloseCallback close
close handle (rw)
Definition: cpl_vsi.h:592
int VSIRmdirRecursive(const char *pszDirname)
Delete a directory recursively.
Definition: cpl_vsil.cpp:690
void VSIInstallAzureFileHandler(void)
Install /vsiaz/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_az.cpp:2277
void VSIStdoutSetRedirection(VSIWriteFunction pFct, FILE *stream)
Set an alternative write function and output file handle instead of fwrite() / stdout.
Definition: cpl_vsil_stdout.cpp:63
void VSIClearCredentials(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:2802
GIntBig CPLGetUsablePhysicalRAM(void)
Return the total physical RAM, usable by a process, in bytes.
Definition: cpl_vsisimple.cpp:1459
int(* VSIFilesystemPluginRenameCallback)(void *pUserData, const char *oldpath, const char *newpath)
Rename handle.
Definition: cpl_vsi.h:481
void VSIFreeAligned(void *ptr)
Free a buffer allocated with VSIMallocAligned().
Definition: cpl_vsisimple.cpp:974
unsigned char GByte
Unsigned byte type.
Definition: cpl_port.h:203
char ** VSISiblingFiles(const char *pszPath)
Return related filenames.
Definition: cpl_vsil.cpp:151
void * VSIMallocVerbose(size_t nSize, const char *pszFile, int nLine)
VSIMallocVerbose.
Definition: cpl_vsisimple.cpp:1137
GByte * VSIGetMemFileBuffer(const char *pszFilename, vsi_l_offset *pnDataLength, int bUnlinkAndSeize)
Fetch buffer underlying memory file.
Definition: cpl_vsi_mem.cpp:1010
int(* VSIFilesystemPluginEofCallback)(void *pFile)
Has end of file been reached.
Definition: cpl_vsi.h:543
int VSIRmdir(const char *pszDirname)
Delete a directory.
Definition: cpl_vsil.cpp:663
bool VSISupportsRandomWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports random write.
Definition: cpl_vsil.cpp:1031
void * VSIReallocVerbose(void *pOldPtr, size_t nNewSize, const char *pszFile, int nLine)
VSIReallocVerbose.
Definition: cpl_vsisimple.cpp:1223
void VSIInstallWebHdfsHandler(void)
Install /vsiwebhdfs/ WebHDFS (Hadoop File System) REST API file system handler (requires libcurl)
Definition: cpl_vsil_webhdfs.cpp:1239
void VSIFreeFilesystemPluginCallbacksStruct(VSIFilesystemPluginCallbacksStruct *poCb)
free resources allocated by VSIAllocFilesystemPluginCallbacksStruct
Definition: cpl_vsil_plugin.cpp:370
VSIFilesystemPluginSeekCallback seek
set current position of handle (rw)
Definition: cpl_vsi.h:584
void VSIInstallStdoutHandler(void)
Install /vsistdout/ file system handler.
Definition: cpl_vsil_stdout.cpp:455
int(* VSIFilesystemPluginStatCallback)(void *pUserData, const char *pszFilename, VSIStatBufL *pStatBuf, int nFlags)
Return information about a handle.
Definition: cpl_vsi.h:471
int nMode
File mode.
Definition: cpl_vsi.h:371
char * VSIGetSignedURL(const char *pszFilename, CSLConstList papszOptions)
Returns a signed URL of a supplied filename.
Definition: cpl_vsil.cpp:1134
int VSIFTruncateL(VSILFILE *, vsi_l_offset)
Truncate/expand the file to the specified size.
Definition: cpl_vsil.cpp:2248
void VSICloseDir(VSIDIR *dir)
Close a directory.
Definition: cpl_vsil.cpp:322
VSILFILE * VSIFileFromMemBuffer(const char *pszFilename, GByte *pabyData, vsi_l_offset nDataLength, int bTakeOwnership)
Create memory "file" from a buffer.
Definition: cpl_vsi_mem.cpp:942
void VSIInstallAzureStreamingFileHandler(void)
Install /vsiaz_streaming/ Microsoft Azure Blob file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2081
void * VSIRealloc(void *, size_t)
Analog of realloc().
Definition: cpl_vsisimple.cpp:680
void VSIInstallSubFileHandler(void)
Install /vsisubfile/ virtual file handler.
Definition: cpl_vsil_subfile.cpp:509
int(* VSIFilesystemPluginFlushCallback)(void *pFile)
Sync written bytes.
Definition: cpl_vsi.h:553
char * pszName
Filename.
Definition: cpl_vsi.h:369
int VSIInstallPluginHandler(const char *pszPrefix, const VSIFilesystemPluginCallbacksStruct *poCb)
register a handler on the given prefix.
Definition: cpl_vsil_plugin.cpp:360
VSIRangeStatus
Range status.
Definition: cpl_vsi.h:178
GIntBig CPLGetPhysicalRAM(void)
Return the total physical RAM in bytes.
Definition: cpl_vsisimple.cpp:1368
vsi_l_offset(* VSIFilesystemPluginTellCallback)(void *pFile)
Return current position in handle.
Definition: cpl_vsi.h:516
int VSIMkdir(const char *pszPathname, long mode)
Create a directory.
Definition: cpl_vsil.cpp:347
VSIFilesystemPluginFlushCallback flush
sync bytes (w)
Definition: cpl_vsi.h:590
char ** VSIGetFileMetadata(const char *pszFilename, const char *pszDomain, CSLConstList papszOptions)
Get metadata on files.
Definition: cpl_vsil.cpp:829
int VSIRename(const char *oldpath, const char *newpath)
Rename a file.
Definition: cpl_vsil.cpp:498
int VSIMkdirRecursive(const char *pszPathname, long mode)
Create a directory and all its ancestors.
Definition: cpl_vsil.cpp:370
VSILFILE * VSIFOpenExL(const char *, const char *, int)
Open file.
Definition: cpl_vsil.cpp:1722
int VSISync(const char *pszSource, const char *pszTarget, const char *const *papszOptions, GDALProgressFunc pProgressFunc, void *pProgressData, char ***ppapszOutputs)
Synchronize a source file/directory with a target file/directory.
Definition: cpl_vsil.cpp:584
void VSIRewindL(VSILFILE *)
Rewind the file pointer to the beginning of the file.
Definition: cpl_vsil.cpp:1953
VSIFilesystemPluginReadCallback read
read from current position (r)
Definition: cpl_vsi.h:585
int VSIIsCaseSensitiveFS(const char *pszFilename)
Returns if the filenames of the filesystem are case sensitive.
Definition: cpl_vsil.cpp:922
char **(* VSIFilesystemPluginReadDirCallback)(void *pUserData, const char *pszDirname, int nMaxFiles)
List directory content.
Definition: cpl_vsi.h:496
size_t(* VSIWriteFunction)(const void *ptr, size_t size, size_t nmemb, FILE *stream)
Callback used by VSIStdoutSetRedirection()
Definition: cpl_vsi.h:464
int VSIHasOptimizedReadMultiRange(const char *pszPath)
Returns if the filesystem supports efficient multi-range reading.
Definition: cpl_vsil.cpp:1057
VSIFilesystemPluginTellCallback tell
get current position of handle (rw)
Definition: cpl_vsi.h:583
size_t nCacheSize
max mem to use per file when buffering
Definition: cpl_vsi.h:594
const char * VSIGetPathSpecificOption(const char *pszPath, const char *pszKey, const char *pszDefault)
Get the value a path specific option.
Definition: cpl_vsil.cpp:2859
struct containing callbacks to used by the handler.
Definition: cpl_vsi.h:571
int VSIFPrintfL(VSILFILE *, const char *,...)
Formatted write to file.
Definition: cpl_vsil.cpp:2274
VSILFILE * VSIFOpenEx2L(const char *, const char *, int, CSLConstList)
Open file.
Definition: cpl_vsil.cpp:1772
void VSIInstallSparseFileHandler(void)
Install /vsisparse/ virtual file handler.
Definition: cpl_vsil_sparsefile.cpp:550
int(* VSIFilesystemPluginSeekCallback)(void *pFile, vsi_l_offset nOffset, int nWhence)
Seek to position in handle.
Definition: cpl_vsi.h:521
void VSIInstallADLSFileHandler(void)
Install /vsiaz/ Microsoft Azure Data Lake Storage Gen2 file system handler (requires libcurl)
Definition: cpl_vsil_adls.cpp:2185
vsi_l_offset nSize
File size.
Definition: cpl_vsi.h:373
VSIRangeStatus(* VSIFilesystemPluginGetRangeStatusCallback)(void *pFile, vsi_l_offset nOffset, vsi_l_offset nLength)
Get empty ranges.
Definition: cpl_vsi.h:538
const char * VSIGetFileSystemOptions(const char *pszFilename)
Return the list of options associated with a virtual file system handler as a serialized XML string.
Definition: cpl_vsil.cpp:2718
#define CPL_C_START
Macro to start a block of C symbols.
Definition: cpl_port.h:304
@ VSI_RANGE_STATUS_UNKNOWN
Unknown.
Definition: cpl_vsi.h:180
int * VSIUnlinkBatch(CSLConstList papszFiles)
Delete several files, possibly in a batch.
Definition: cpl_vsil.cpp:454
VSIRangeStatus VSIFGetRangeStatusL(VSILFILE *fp, vsi_l_offset nStart, vsi_l_offset nLength)
Return if a given file range contains data or holes filled with zeroes.
Definition: cpl_vsil.cpp:2363
char ** papszExtra
NULL-terminated list of extra properties.
Definition: cpl_vsi.h:383
void VSIInstallS3FileHandler(void)
Install /vsis3/ Amazon S3 file system handler (requires libcurl)
Definition: cpl_vsil_s3.cpp:4759
VSIFilesystemPluginCallbacksStruct * VSIAllocFilesystemPluginCallbacksStruct(void)
return a VSIFilesystemPluginCallbacksStruct to be populated at runtime with handler callbacks
Definition: cpl_vsil_plugin.cpp:367
void VSIClearPathSpecificOptions(const char *pszPathPrefix)
Clear path specific options set with VSISetPathSpecificOption()
Definition: cpl_vsil.cpp:2818
void VSIInstallGZipFileHandler(void)
Install GZip file system handler.
Definition: cpl_vsil_gzip.cpp:2477
char ** VSIReadDirEx(const char *pszPath, int nMaxFiles)
Read names in a directory.
Definition: cpl_vsil.cpp:123
size_t(* VSIFilesystemPluginReadCallback)(void *pFile, void *pBuffer, size_t nSize, size_t nCount)
Read data from current position, returns the number of blocks correctly read.
Definition: cpl_vsi.h:527
VSIFilesystemPluginUnlinkCallback unlink
unlink handle by name ()
Definition: cpl_vsi.h:577
char ** CSLConstList
Type of a constant null-terminated list of nul terminated strings.
Definition: cpl_port.h:1056
vsi_l_offset VSIFTellL(VSILFILE *)
Tell current file offset.
Definition: cpl_vsil.cpp:1931
unsigned long long GUIntBig
Large unsigned integer type (generally 64-bit unsigned integer type).
Definition: cpl_port.h:233
VSIFilesystemPluginGetRangeStatusCallback get_range_status
get range status ()
Definition: cpl_vsi.h:587
VSIFilesystemPluginRenameCallback rename
rename handle ()
Definition: cpl_vsi.h:578
int VSIFSeekL(VSILFILE *, vsi_l_offset, int)
Seek to requested offset.
Definition: cpl_vsil.cpp:1888
int(* VSIFilesystemPluginUnlinkCallback)(void *pUserData, const char *pszFilename)
Remove handle by name.
Definition: cpl_vsi.h:476
void VSIInstallGSFileHandler(void)
Install /vsigs/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_gs.cpp:824
#define CPL_C_END
Macro to end a block of C symbols.
Definition: cpl_port.h:306
void VSIInstallStdinHandler(void)
Install /vsistdin/ file system handler.
Definition: cpl_vsil_stdin.cpp:653
void VSIInstallHdfsHandler(void)
Install /vsihdfs/ file system handler (requires JVM and HDFS support)
Definition: cpl_vsil_hdfs.cpp:414
int(* VSIFilesystemPluginMkdirCallback)(void *pUserData, const char *pszDirname, long nMode)
Create Directory.
Definition: cpl_vsi.h:486
void * VSIMalloc3Verbose(size_t nSize1, size_t nSize2, size_t nSize3, const char *pszFile, int nLine)
VSIMalloc3Verbose.
Definition: cpl_vsisimple.cpp:1179
Directory entry.
Definition: cpl_vsi.h:366
int VSIStatL(const char *, VSIStatBufL *)
Get filesystem object info.
Definition: cpl_vsil.cpp:727
int VSIUnlink(const char *pszFilename)
Delete a file.
Definition: cpl_vsil.cpp:422
void VSIInstallCryptFileHandler(void)
Install /vsicrypt/ encrypted file system handler (requires libcrypto++)
Definition: cpl_vsil_crypt.cpp:2046
void VSIInstallGSStreamingFileHandler(void)
Install /vsigs_streaming/ Google Cloud Storage file system handler (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2061
int(* VSIFilesystemPluginRmdirCallback)(void *pUserData, const char *pszDirname)
Delete Directory.
Definition: cpl_vsi.h:491
int VSISupportsSparseFiles(const char *pszPath)
Returns if the filesystem supports sparse files.
Definition: cpl_vsil.cpp:952
void * VSIMalloc2Verbose(size_t nSize1, size_t nSize2, const char *pszFile, int nLine)
VSIMalloc2Verbose.
Definition: cpl_vsisimple.cpp:1154
char ** VSIGetFileSystemsPrefixes(void)
Return the list of prefixes for virtual file system handlers currently registered.
Definition: cpl_vsil.cpp:2698
void VSIInstallCurlStreamingFileHandler(void)
Install /vsicurl_streaming/ HTTP/FTP file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2020
int(* VSIFilesystemPluginTruncateCallback)(void *pFile, vsi_l_offset nNewSize)
Truncate handle.
Definition: cpl_vsi.h:557
void VSIInstallCurlFileHandler(void)
Install /vsicurl/ HTTP/FTP file system handler (requires libcurl)
Definition: cpl_vsil_curl.cpp:5530
char * VSIStrerror(int)
Return the error string corresponding to the error number.
Definition: cpl_vsisimple.cpp:1346
void VSISetCredential(const char *pszPathPrefix, const char *pszKey, const char *pszValue)
Set a credential (or more generally an option related to a virtual file system) for a given path pref...
Definition: cpl_vsil.cpp:2742
void VSIInstallTarFileHandler(void)
Install /vsitar/ file system handler.
Definition: cpl_vsil_tar.cpp:640
int VSIFFlushL(VSILFILE *)
Flush pending writes to disk.
Definition: cpl_vsil.cpp:1994
int(* VSIFilesystemPluginReadMultiRangeCallback)(void *pFile, int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes)
Read from multiple offsets.
Definition: cpl_vsi.h:532
char **(* VSIFilesystemPluginSiblingFilesCallback)(void *pUserData, const char *pszDirname)
List related files.
Definition: cpl_vsi.h:505
char * VSINetworkStatsGetAsSerializedJSON(char **papszOptions)
Return network related statistics, as a JSON serialized object.
Definition: cpl_vsil_curl.cpp:5714
void VSIInstallMemFileHandler(void)
Install "memory" file system handler.
Definition: cpl_vsi_mem.cpp:910
void VSIInstallZipFileHandler(void)
Install ZIP file system handler.
Definition: cpl_vsil_gzip.cpp:3332
GUIntBig vsi_l_offset
Type for a file offset.
Definition: cpl_vsi.h:142
void VSIFree(void *)
Analog of free() for data allocated with VSIMalloc(), VSICalloc(), VSIRealloc()
Definition: cpl_vsisimple.cpp:826
VSIFilesystemPluginStatCallback stat
stat handle by name (rw)
Definition: cpl_vsi.h:576
void VSIInstallOSSFileHandler(void)
Install /vsioss/ Alibaba Cloud Object Storage Service (OSS) file system handler (requires libcurl)
Definition: cpl_vsil_oss.cpp:409
void * VSIMalloc2(size_t nSize1, size_t nSize2)
VSIMalloc2 allocates (nSize1 * nSize2) bytes.
Definition: cpl_vsisimple.cpp:1115
char * VSIStrdup(const char *)
Analog of strdup().
Definition: cpl_vsisimple.cpp:994
void * VSICalloc(size_t, size_t)
Analog of calloc().
Definition: cpl_vsisimple.cpp:443
char * VSIStrdupVerbose(const char *pszStr, const char *pszFile, int nLine)
VSIStrdupVerbose.
Definition: cpl_vsisimple.cpp:1241
void * VSIMallocAlignedAuto(size_t nSize)
Allocates a buffer with an alignment constraint such that it can be used by the most demanding vector...
Definition: cpl_vsisimple.cpp:937
int VSIFCloseL(VSILFILE *)
Close file.
Definition: cpl_vsil.cpp:1828
VSIFilesystemPluginMkdirCallback mkdir
make directory ()
Definition: cpl_vsi.h:579
VSIFilesystemPluginRmdirCallback rmdir
remove directory ()
Definition: cpl_vsi.h:580
void VSISetPathSpecificOption(const char *pszPathPrefix, const char *pszKey, const char *pszValue)
Set a path specific option for a given path prefix.
Definition: cpl_vsil.cpp:2776
const char * VSIGetCredential(const char *pszPath, const char *pszKey, const char *pszDefault)
Get the value of a credential (or more generally an option related to a virtual file system) for a gi...
Definition: cpl_vsil.cpp:2841
int VSIFReadMultiRangeL(int nRanges, void **ppData, const vsi_l_offset *panOffsets, const size_t *panSizes, VSILFILE *)
Read several ranges of bytes from file.
Definition: cpl_vsil.cpp:2106
void * VSIMalloc(size_t)
Analog of malloc().
Definition: cpl_vsisimple.cpp:557
char ** VSIReadDirRecursive(const char *pszPath)
Read names in a directory recursively.
Definition: cpl_vsil.cpp:185
long long GIntBig
Large signed integer type (generally 64-bit integer type).
Definition: cpl_port.h:230
void *(* VSIFilesystemPluginOpenCallback)(void *pUserData, const char *pszFilename, const char *pszAccess)
Open a handle.
Definition: cpl_vsi.h:511
int VSIStatExL(const char *pszFilename, VSIStatBufL *psStatBuf, int nFlags)
Get filesystem object info.
Definition: cpl_vsil.cpp:766
GIntBig nMTime
Last modification time (seconds since 1970/01/01)
Definition: cpl_vsi.h:375
VSIFilesystemPluginSiblingFilesCallback sibling_files
list related files
Definition: cpl_vsi.h:595
char bModeKnown
Whether nMode is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:377
struct VSIDIR VSIDIR
Opaque type for a directory iterator.
Definition: cpl_vsi.h:355
VSIFilesystemPluginReadDirCallback read_dir
list directory content (r?)
Definition: cpl_vsi.h:581
bool VSISupportsSequentialWrite(const char *pszPath, bool bAllowLocalTempFile)
Returns if the filesystem supports sequential write.
Definition: cpl_vsil.cpp:1006
void VSISetCryptKey(const GByte *pabyKey, int nKeySize)
Installs the encryption/decryption key.
Definition: cpl_vsil_crypt.cpp:207
#define CPL_WARN_UNUSED_RESULT
Qualifier to warn when the return value of a function is not used.
Definition: cpl_port.h:869
#define VSIStatBufL
Type for VSIStatL()
Definition: cpl_vsi.h:200
size_t VSIFWriteL(const void *, size_t, size_t, VSILFILE *)
Write bytes to file.
Definition: cpl_vsil.cpp:2160
GIntBig VSIGetDiskFreeSpace(const char *pszDirname)
Return free disk space available on the filesystem.
Definition: cpl_vsil.cpp:2676
#define CPL_FORMAT_STRING(arg)
Macro into which to wrap the format argument of a printf-like function.
Definition: cpl_port.h:859
void VSIInstallOSSStreamingFileHandler(void)
Install /vsiaz_streaming/ Alibaba Cloud Object Storage Service (OSS) (requires libcurl)
Definition: cpl_vsil_curl_streaming.cpp:2102
void VSIInstallSwiftStreamingFileHandler(void)
Install /vsiswift_streaming/ OpenStack Swif Object Storage (Swift) file system handler (requires libc...
Definition: cpl_vsil_curl_streaming.cpp:2123
void VSICurlPartialClearCache(const char *pszFilenamePrefix)
Clean local cache associated with /vsicurl/ (and related file systems) for a given filename (and its ...
Definition: cpl_vsil_curl.cpp:5592
void VSIInstallS3StreamingFileHandler(void)
Install /vsis3_streaming/ Amazon S3 file system handler (requires libcurl).
Definition: cpl_vsil_curl_streaming.cpp:2040
void * VSIMallocAlignedAutoVerbose(size_t nSize, const char *pszFile, int nLine)
See VSIMallocAlignedAuto()
Definition: cpl_vsisimple.cpp:950
int VSIFEofL(VSILFILE *)
Test for end of file.
Definition: cpl_vsil.cpp:2206
VSILFILE * VSIFOpenL(const char *, const char *)
Open file.
Definition: cpl_vsil.cpp:1172
bool VSIIsLocal(const char *pszPath)
Returns if the file/filesystem is "local".
Definition: cpl_vsil.cpp:981
void * VSIMallocAligned(size_t nAlignment, size_t nSize)
Allocates a buffer with an alignment constraint.
Definition: cpl_vsisimple.cpp:891
char ** VSIReadDir(const char *)
Read names in a directory.
Definition: cpl_vsil.cpp:89
void VSINetworkStatsReset(void)
Clear network related statistics.
Definition: cpl_vsil_curl.cpp:5616
VSIFilesystemPluginEofCallback eof
has end of file been reached (r?)
Definition: cpl_vsi.h:588
VSIFilesystemPluginReadMultiRangeCallback read_multi_range
read multiple blocks ()
Definition: cpl_vsi.h:586
VSIFilesystemPluginTruncateCallback truncate
truncate handle (w?)
Definition: cpl_vsi.h:591
VSIFilesystemPluginOpenCallback open
open handle by name (rw)
Definition: cpl_vsi.h:582
void VSICurlClearCache(void)
Clean local cache associated with /vsicurl/ (and related file systems)
Definition: cpl_vsil_curl.cpp:5553
int VSISetFileMetadata(const char *pszFilename, CSLConstList papszMetadata, const char *pszDomain, CSLConstList papszOptions)
Set metadata on files.
Definition: cpl_vsil.cpp:886
char bSizeKnown
Whether nSize is known: 0 = unknown, 1 = known.
Definition: cpl_vsi.h:379
int VSIIngestFile(VSILFILE *fp, const char *pszFilename, GByte **ppabyRet, vsi_l_offset *pnSize, GIntBig nMaxSize)
Ingest a file into memory.
Definition: cpl_vsil.cpp:2400
int VSIFPutcL(int, VSILFILE *)
Write a single byte to the file.
Definition: cpl_vsil.cpp:2311
void * pUserData
Optional opaque pointer passed back to filemanager callbacks (e.g.
Definition: cpl_vsi.h:575
size_t(* VSIFilesystemPluginWriteCallback)(void *pFile, const void *pBuffer, size_t nSize, size_t nCount)
Write bytes at current offset.
Definition: cpl_vsi.h:548
const char * VSIGetActualURL(const char *pszFilename)
Returns the actual URL of a supplied filename.
Definition: cpl_vsil.cpp:1087
int VSIAbortPendingUploads(const char *pszFilename)
Abort ongoing multi-part uploads.
Definition: cpl_vsil.cpp:635
void * VSIMalloc3(size_t nSize1, size_t nSize2, size_t nSize3)
VSIMalloc3 allocates (nSize1 * nSize2 * nSize3) bytes.
Definition: cpl_vsisimple.cpp:1128
VSIFilesystemPluginWriteCallback write
write bytes to current position (w)
Definition: cpl_vsi.h:589
@ VSI_RANGE_STATUS_DATA
Data present.
Definition: cpl_vsi.h:181
void * VSIFGetNativeFileDescriptorL(VSILFILE *)
Returns the "native" file descriptor for the virtual handle.
Definition: cpl_vsil.cpp:2655
int(* VSIFilesystemPluginCloseCallback)(void *pFile)
Close file handle.
Definition: cpl_vsi.h:562
void * VSICallocVerbose(size_t nCount, size_t nSize, const char *pszFile, int nLine)
VSICallocVerbose.
Definition: cpl_vsisimple.cpp:1204
FILE VSILFILE
Opaque type for a FILE that implements the VSIVirtualHandle API.
Definition: cpl_vsi.h:158
size_t VSIFReadL(void *, size_t, size_t, VSILFILE *)
Read bytes from file.
Definition: cpl_vsil.cpp:2046