public class Sandbox.BaseFileSystem

public void CreateDirectory(string folder)

Create a directory - or a tree of directories. Returns silently if the directory already exists.

public Sandbox.BaseFileSystem CreateSubSystem(string path)

Create a sub-filesystem at the specified path

public void DeleteDirectory(string folder, bool recursive = False)

Delete a folder and optionally all of its contents

public void DeleteFile(string path)

Delete a file

public bool DirectoryExists(string path)

Returns true if the directory exists on this filesystem

public int DirectorySize(string path, bool recursive = False)

Gets the size in bytes of all the files in a directory

public bool FileExists(string path)

Returns true if the file exists on this filesystem

public long FileSize(string filepath)

Returns file size of given file.

public System.Collections.Generic.IEnumerable`1<string> FindDirectory(string folder, string pattern = *, bool recursive = False)

Get a list of directories

public System.Collections.Generic.IEnumerable`1<string> FindFile(string folder, string pattern = *, bool recursive = False)

Get a list of files

public ulong GetCrc(string filepath)

Returns CRC64 of the file contents.

public System.Threading.Tasks.Task`1<ulong> GetCrcAsync(string filepath)

Returns CRC64 of the file contents.

public string GetFullPath(string path)

Returns the full physical path to a file or folder on disk, or null if it isn't on disk.

public System.IO.Stream OpenRead(string path, System.IO.FileMode mode = 3)

Open a file for read. Will throw an exception if it doesn't exist.

public System.IO.Stream OpenWrite(string path, System.IO.FileMode mode = 2)

Open a file for write. If the file exists we'll overwrite it (by default)

public System.Span`1<byte> ReadAllBytes(string path)

Read the contents of path and return it as a string

public System.Threading.Tasks.Task`1<byte[]> ReadAllBytesAsync(string path)

Read the contents of path and return it as a string

public string ReadAllText(string path)

Read the contents of path and return it as a string. Returns null if file not found.

public System.Threading.Tasks.Task`1<string> ReadAllTextAsync(string path)

Read the contents of path and return it as a string

public T ReadJson(string filename, T defaultValue = null)

Read Json from a file using System.Text.Json.JsonSerializer. This will throw exceptions if not valid json.

public T ReadJsonOrDefault(string filename, T returnOnError = null)

The same as ReadJson except will return a default value on missing/error.

public void WriteAllBytes(string path, byte[] contents)

Write the contents to the path. The file will be over-written if the file exists

public void WriteAllText(string path, string contents)

Write the contents to the path. The file will be over-written if the file exists

public void WriteJson(string filename, T data)

Convert object to json and write it to the specified file

public bool Sandbox.BaseFileSystem.IsReadOnly { get; set; }

Returns true if this filesystem is read only

public bool Sandbox.BaseFileSystem.IsValid { get; set; }