Defines file system input/output functions.
kSbFileErrorAccessDenied is returned when a call fails because of a filesystem restriction. kSbFileErrorSecurity is returned when a security policy doesn't allow the operation to be executed.
Values
kSbFileOkkSbFileErrorFailedkSbFileErrorInUsekSbFileErrorExistskSbFileErrorNotFoundkSbFileErrorAccessDeniedkSbFileErrorTooManyOpenedkSbFileErrorNoMemorykSbFileErrorNoSpacekSbFileErrorNotADirectorykSbFileErrorInvalidOperationkSbFileErrorSecuritykSbFileErrorAbortkSbFileErrorNotAFilekSbFileErrorNotEmptykSbFileErrorInvalidUrlkSbFileErrorMax - Put new entries here and increment kSbFileErrorMax.Flags that define how a file is used in the application. These flags should be or'd together when passed to SbFileOpen to open or create a file.
The following five flags are mutually exclusive. You must specify exactly one of them:
Values
kSbFileOpenOnly - Opens a file, only if it exists.kSbFileCreateOnly - Creates a new file, only if it does not already exist.kSbFileOpenAlways - Opens an existing file at the specified path or creates a new file at that path.kSbFileCreateAlways - Creates a new file at the specified path or overwrites an existing file at that path.kSbFileOpenTruncated - Opens a file and truncates it to zero, only if it exists.kSbFileReadkSbFileWritekSbFileAsync - May allow asynchronous I/O on some platforms, meaning that calls to Read or Write will only return the data that is readily available.This explicit mapping matches both FILE_ on Windows and SEEK_ on Linux.
Values
kSbFileFromBeginkSbFileFromCurrentkSbFileFromEndUsed to hold information about a file.
Members
Private structure representing an open file.
Description
Indicates whether SbFileOpen() with the given flags is allowed for path.
Declaration and definitions
#include "starboard/file.h"
bool SbFileCanOpen(const char* /*path*/, int /*flags*/) {
return false;
}
Parameters
Description
Closes file. The return value indicates whether the file was closed successfully.
Declaration and definitions
#include "starboard/file.h"
bool SbFileClose(SbFile /*file*/) {
return false;
}
Parameters
Description
Deletes the regular file, symlink, or empty directory at path. This function is used primarily to clean up after unit tests. On some platforms, this function fails if the file in question is being held open.
Declaration and definitions
#include "starboard/file.h"
bool SbFileDelete(const char* /*path*/) {
return false;
}
Parameters
Description
Indicates whether a file or directory exists at path.
Declaration and definitions
#include "starboard/file.h"
bool SbFileExists(const char* /*path*/) {
return false;
}
Parameters
Description
Flushes the write buffer to file. Data written via SbFileWrite is not necessarily committed until the SbFile is flushed or closed.
Declaration and definitions
#include "starboard/file.h"
bool SbFileFlush(SbFile /*file*/) {
return false;
}
Parameters
Description
Retrieves information about file. The return value indicates whether the file information was retrieved successfully.
Declaration and definitions
#include "starboard/file.h"
bool SbFileGetInfo(SbFile /*file*/, SbFileInfo* /*out_info*/) {
return false;
}
Parameters
Description
Retrieves information about the file at path. The return value indicates whether the file information was retrieved successfully.
Declaration and definitions
#include "starboard/file.h"
bool SbFileGetPathInfo(const char* /*path*/, SbFileInfo* /*out_info*/) {
return false;
}
Parameters
Description
Returns whether the given file handle is valid.
Declaration
static SB_C_INLINE bool SbFileIsValid(SbFile file) {
return file != kSbFileInvalid;
}
Parameters
Description
Converts an ISO fopen() mode string into flags that can be equivalently passed into SbFileOpen().
Declaration
SB_EXPORT int SbFileModeStringToFlags(const char* mode);
Parameters
Description
Opens the file at path, which must be absolute, creating it if specified by flags. The read/write position is at the beginning of the file.
Note that this function only guarantees the correct behavior when path points to a file. The behavior is undefined if path points to a directory.
Declaration and definitions
#include "starboard/file.h"
SbFile SbFileOpen(const char* /*path*/,
int /*flags*/,
bool* /*out_created*/,
SbFileError* /*out_error*/) {
return kSbFileInvalid;
}
Parameters
Description
Reads size bytes (or until EOF is reached) from file into data, starting at the file's current position.
The return value specifies the number of bytes read or -1 if there was an error. Note that this function does NOT make a best effort to read all data on all platforms; rather, it just reads however many bytes are quickly available. However, this function can be run in a loop to make it a best-effort read.
Declaration and definitions
#include "starboard/file.h"
int SbFileRead(SbFile /*file*/, char* /*data*/, int /*size*/) {
return 0;
}
Parameters
Description
Reads size bytes (or until EOF is reached) from file into data, starting from the beginning of the file.
The return value specifies the number of bytes read or -1 if there was an error. Note that, unlike SbFileRead, this function does make a best effort to read all data on all platforms. As such, it is not intended for stream-oriented files but instead for cases when the normal expectation is that size bytes can be read unless there is an error.
Declaration
static inline int SbFileReadAll(SbFile file, char* data, int size) {
if (!SbFileIsValid(file) || size < 0) {
return -1;
}
int bytes_read = 0;
int rv;
do {
rv = SbFileRead(file, data + bytes_read, size - bytes_read);
if (bytes_read <= 0) {
break;
}
bytes_read += rv;
} while (bytes_read < size);
return bytes_read ? bytes_read : rv;
}
Parameters
Description
Changes the current read/write position in file. The return value identifies the resultant current read/write position in the file (relative to the start) or -1 in case of an error. This function might not support seeking past the end of the file on some platforms.
Declaration and definitions
#include "starboard/file.h"
int64_t SbFileSeek(SbFile /*file*/,
SbFileWhence /*whence*/,
int64_t /*offset*/) {
return 0;
}
Parameters
Description
Truncates the given file to the given length. The return value indicates whether the file was truncated successfully.
Declaration and definitions
#include "starboard/file.h"
bool SbFileTruncate(SbFile /*file*/, int64_t /*length*/) {
return false;
}
Parameters
Description
Writes the given buffer into file at the file's current position, overwriting any data that was previously there.
The return value identifies the number of bytes written, or -1 on error. Note that this function does NOT make a best effort to write all data; rather, it writes however many bytes can be written quickly. Generally, this means that it writes however many bytes as possible without blocking on IO. Run this function in a loop to ensure that all data is written.
Declaration and definitions
#include "starboard/file.h"
int SbFileWrite(SbFile /*file*/, const char* /*data*/, int /*size*/) {
return 0;
}
Parameters
Description
Writes the given buffer into file, starting at the beginning of the file, and overwriting any data that was previously there. Unlike SbFileWrite, this function does make a best effort to write all data on all platforms.
The return value identifies the number of bytes written, or -1 on error.
Declaration
static inline int SbFileWriteAll(SbFile file, const char* data, int size) {
if (!SbFileIsValid(file) || size < 0) {
return -1;
}
int bytes_written = 0;
int rv;
do {
rv = SbFileWrite(file, data + bytes_written, size - bytes_written);
if (bytes_written <= 0) {
break;
}
bytes_written += rv;
} while (bytes_written < size);
return bytes_written ? bytes_written : rv;
}
Parameters