gitback/known-folders
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix API in readme

Browse Source
This commit is contained in:
XXIV 2023-07-09 01:18:38 +03:00 committed by Felix Queißner
parent d070896807
commit 03b70c3179
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -22,6 +22,7 @@ pub const KnownFolder = enum {
cache,
roaming_configuration,
local_configuration,
global_configuration,
data,
runtime,
executable_dir,
@ -30,14 +31,15 @@ pub const KnownFolder = enum {
pub const Error = error{ ParseError, OutOfMemory };
pub const KnownFolderConfig = struct {
xdg_force_default: bool = false,
xdg_on_mac: bool = false,
};
/// Returns a directory handle, or, if the folder does not exist, `null`.
pub fn open(allocator: *std.mem.Allocator, folder: KnownFolder, args: std.fs.Dir.OpenDirOptions) (std.fs.Dir.OpenError || Error)!?std.fs.Dir;
pub fn open(allocator: std.mem.Allocator, folder: KnownFolder, args: std.fs.Dir.OpenDirOptions) (std.fs.Dir.OpenError || Error)!?std.fs.Dir;
/// Returns the path to the folder or, if the folder does not exist, `null`.
pub fn getPath(allocator: *std.mem.Allocator, folder: KnownFolder) Error!?[]const u8;
pub fn getPath(allocator: std.mem.Allocator, folder: KnownFolder) Error!?[]const u8;
```
## Configuration