nn::fs namespace

Classes

struct DirectoryEntry
struct DirectoryHandle
struct FileHandle
struct FileTimeStamp
struct ReadOption
struct WriteOption

Enums

enum DirectoryEntryType { DirectoryEntryType_Directory, DirectoryEntryType_File }
enum OpenDirectoryMode { OpenDirectoryMode_Directory = 1 << 0, OpenDirectoryMode_File = 1 << 1, OpenDirectoryMode_All = OpenDirectoryMode_Directory | OpenDirectoryMode_File }
enum OpenMode { OpenMode_Read = 1 << 0, OpenMode_Write = 1 << 1, OpenMode_Append = 1 << 2, OpenMode_ReadWrite = OpenMode_Read | OpenMode_Write }
enum WriteOptionFlag { WriteOptionFlag_Flush = 1 << 0 }

Typedefs

using UserId = u64

Functions

auto MountBcatSaveData(const char*, ApplicationId) -> Result
auto CreateBcatSaveData(ApplicationId, s64) -> Result
auto OpenDirectory(DirectoryHandle* handleOut, const char* path, s32 openMode) -> Result
void CloseDirectory(DirectoryHandle handle)
auto ReadDirectory(s64* entryCountOut, DirectoryEntry* entriesOut, DirectoryHandle handle, s64 entryBufferLength) -> Result
auto CreateDirectory(const char* path) -> Result
auto GetDirectoryEntryCount(s64* entryCountOut, DirectoryHandle handle) -> Result
auto DeleteDirectoryRecursively(const char* path) -> Result
auto DeleteDirectory(const char* path) -> Result
auto CleanDirectoryRecursively(const char* path) -> Result
auto RenameDirectory(const char* path, const char* newPath) -> Result
auto GetEntryType(DirectoryEntryType*, const char*) -> Result
auto CreateFile(const char* path, s64 size) -> Result
auto OpenFile(FileHandle* handleOut, const char* path, int mode) -> Result
void CloseFile(FileHandle handle)
auto ReadFile(FileHandle handle, long position, void* buffer, ulong size) -> Result
auto ReadFile(FileHandle handle, long position, void* buffer, const ReadOption& option) -> Result
auto ReadFile(ulong* bytesRead, FileHandle handle, long position, void* buffer) -> Result
auto ReadFile(ulong* bytesRead, FileHandle handle, long position, void* buffer, const ReadOption& option) -> Result
auto ReadFile(u64* outSize, FileHandle handle, s64 offset, void* buffer, u64 bufferSize, const ReadOption& option) -> Result
auto ReadFile(u64* outSize, FileHandle handle, s64 offset, void* buffer, u64 bufferSize) -> Result
auto ReadFile(FileHandle handle, s64 offset, void* buffer, u64 bufferSize, const ReadOption& option) -> Result
auto GetFileSize(long* size, nn::fs::FileHandle handle) -> Result
auto WriteFile(FileHandle handle, s64 position, void const* buffer, u64 size, WriteOption const& option) -> Result
auto FlushFile(FileHandle handle) -> Result
auto GetFileTimeStampForDebug(nn::fs::FileTimeStamp*, const char*) -> Result
auto DeleteFile(const char* path) -> Result
auto SetFileSize(FileHandle fileHandle, s64 filesize) -> Result
auto RenameFile(const char* filepath, const char* newPath) -> Result
auto MountSdCardForDebug(const char* mount) -> bool
auto MountSdCard(const char* mountPoint) -> Result
auto IsSdCardInserted() -> bool
auto FormatSdCard() -> Result
auto FormatSdCardDryRun() -> Result
auto IsExFatSupported() -> bool
auto MountHost(const char* mount, const char* path) -> Result
auto MountHostRoot() -> Result
auto UnmountHostRoot() -> Result
auto Unmount(const char* mountPoint) -> Result
auto QueryMountRomCacheSize(size_t* size) -> Result
auto QueryMountRomCacheSize(size_t* size, nn::ApplicationId) -> Result
auto QueryMountAddOnContentCacheSize(size_t* size, int id) -> Result
auto MountRom(const char* name, void* cache, size_t cache_size) -> Result
auto MountAddOnContent(const char* name, int id, void* cache, size_t cache_size) -> Result
auto CanMountRomForDebug() -> bool
auto CanMountRom(nn::ApplicationId) -> Result
auto QueryMountRomOnFileCacheSize(u64*, FileHandle) -> Result
auto MountRomOnFile(const char*, FileHandle, void*, u64) -> Result
auto EnsureSaveData(const nn::account::Uid&) -> Result
auto MountSaveData(const char*, UserId) -> Result
auto MountSaveDataForDebug(const char*) -> Result
auto CommitSaveData(const char* path) -> Result

Variables

s32 PathLengthMax constexpr

Enum documentation

enum nn::fs::DirectoryEntryType
#include <nn/fs/fs_types.h>

enum nn::fs::OpenDirectoryMode
#include <nn/fs/fs_types.h>

enum nn::fs::OpenMode
#include <nn/fs/fs_types.h>

enum nn::fs::WriteOptionFlag
#include <nn/fs/fs_types.h>

Typedef documentation

typedef u64 nn::fs::UserId
#include <nn/fs/fs_types.h>

Function documentation

Result nn::fs::MountBcatSaveData(const char*, ApplicationId)
#include <nn/fs/fs_bcat.h>

Result nn::fs::OpenDirectory(DirectoryHandle* handleOut, const char* path, s32 openMode)
#include <nn/fs/fs_directories.h>

Result nn::fs::ReadDirectory(s64* entryCountOut, DirectoryEntry* entriesOut, DirectoryHandle handle, s64 entryBufferLength)
#include <nn/fs/fs_directories.h>

Result nn::fs::CreateDirectory(const char* path)
#include <nn/fs/fs_directories.h>

Result nn::fs::GetDirectoryEntryCount(s64* entryCountOut, DirectoryHandle handle)
#include <nn/fs/fs_directories.h>

Result nn::fs::DeleteDirectoryRecursively(const char* path)
#include <nn/fs/fs_directories.h>

Result nn::fs::DeleteDirectory(const char* path)
#include <nn/fs/fs_directories.h>

Result nn::fs::CleanDirectoryRecursively(const char* path)
#include <nn/fs/fs_directories.h>

Result nn::fs::RenameDirectory(const char* path, const char* newPath)
#include <nn/fs/fs_directories.h>

Result nn::fs::CreateFile(const char* path, s64 size)
#include <nn/fs/fs_files.h>

Result nn::fs::OpenFile(FileHandle* handleOut, const char* path, int mode)
#include <nn/fs/fs_files.h>

void nn::fs::CloseFile(FileHandle handle)
#include <nn/fs/fs_files.h>

Result nn::fs::ReadFile(FileHandle handle, long position, void* buffer, ulong size)
#include <nn/fs/fs_files.h>

Result nn::fs::ReadFile(FileHandle handle, long position, void* buffer, const ReadOption& option)
#include <nn/fs/fs_files.h>

Result nn::fs::ReadFile(ulong* bytesRead, FileHandle handle, long position, void* buffer)
#include <nn/fs/fs_files.h>

Result nn::fs::ReadFile(ulong* bytesRead, FileHandle handle, long position, void* buffer, const ReadOption& option)
#include <nn/fs/fs_files.h>

Result nn::fs::ReadFile(u64* outSize, FileHandle handle, s64 offset, void* buffer, u64 bufferSize, const ReadOption& option)
#include <nn/fs/fs_files.h>

Result nn::fs::ReadFile(u64* outSize, FileHandle handle, s64 offset, void* buffer, u64 bufferSize)
#include <nn/fs/fs_files.h>

Result nn::fs::ReadFile(FileHandle handle, s64 offset, void* buffer, u64 bufferSize, const ReadOption& option)
#include <nn/fs/fs_files.h>

Result nn::fs::GetFileSize(long* size, nn::fs::FileHandle handle)
#include <nn/fs/fs_files.h>

Result nn::fs::WriteFile(FileHandle handle, s64 position, void const* buffer, u64 size, WriteOption const& option)
#include <nn/fs/fs_files.h>

Result nn::fs::FlushFile(FileHandle handle)
#include <nn/fs/fs_files.h>

Result nn::fs::DeleteFile(const char* path)
#include <nn/fs/fs_files.h>

Result nn::fs::SetFileSize(FileHandle fileHandle, s64 filesize)
#include <nn/fs/fs_files.h>

Result nn::fs::RenameFile(const char* filepath, const char* newPath)
#include <nn/fs/fs_files.h>

bool nn::fs::MountSdCardForDebug(const char* mount)
#include <nn/fs/fs_mount.h>

Result nn::fs::MountSdCard(const char* mountPoint)
#include <nn/fs/fs_mount.h>

bool nn::fs::IsSdCardInserted()
#include <nn/fs/fs_mount.h>

bool nn::fs::IsExFatSupported()
#include <nn/fs/fs_mount.h>

Result nn::fs::MountHost(const char* mount, const char* path)
#include <nn/fs/fs_mount.h>

Result nn::fs::Unmount(const char* mountPoint)
#include <nn/fs/fs_mount.h>

Result nn::fs::MountRom(const char* name, void* cache, size_t cache_size)
#include <nn/fs/fs_rom.h>

Result nn::fs::MountAddOnContent(const char* name, int id, void* cache, size_t cache_size)
#include <nn/fs/fs_rom.h>

bool nn::fs::CanMountRomForDebug()
#include <nn/fs/fs_rom.h>

Result nn::fs::MountRomOnFile(const char*, FileHandle, void*, u64)
#include <nn/fs/fs_rom.h>

Result nn::fs::MountSaveData(const char*, UserId)
#include <nn/fs/fs_save.h>

Result nn::fs::MountSaveDataForDebug(const char*)
#include <nn/fs/fs_save.h>

Result nn::fs::CommitSaveData(const char* path)
#include <nn/fs/fs_save.h>

Variable documentation

s32 nn::fs::PathLengthMax constexpr
#include <nn/fs/fs_types.h>