Class UserStorage

Namespace: Sdl3Sharp.IO

Assembly: Sdl3Sharp.dll

A storage area for a user's unique read/write file system

public sealed class UserStorage : Storage, IDisposable

Inheritance: object

Storage

UserStorage

Implements: IDisposable

Inherited Members: Storage.IsReady

Storage.IsValid

Storage.RemainingSpace

Storage.SdlStorage

Storage.Dispose()

Storage.EnumerateDirectory(string)

Storage.PathExists(string)

Storage.TryClose()

Storage.TryCopyFile(string, string)

Storage.TryCreateDirectory(string)

Storage.TryEnumerateDirectory(string, EnumerateDirectoryCallback)

Storage.TryGetFileLength(string, out ulong)

Storage.TryGetPathInfo(string, out PathInfo)

Storage.TryGlobDirectory(string, string, GlobFlags, out string[])

Storage.TryReadFile(string, NativeMemory)

Storage.TryReadFile(string, Span<byte>)

Storage.TryReadFile(string, void*, ulong)

Storage.TryRemovePath(string)

Storage.TryRenamePath(string, string)

Storage.TryWriteFile(string, ReadOnlyNativeMemory)

Storage.TryWriteFile(string, ReadOnlySpan<byte>)

Storage.TryWriteFile(string, void*, ulong)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

UserStorage(string, string, Properties?)

Creates a new UserStorage

public UserStorage(string orgName, string appName, Properties? properties = null)

Parameters

orgName string: The name of your organization
appName string: The name of your application
properties Properties: An optional group of properties that may contain backend-specific information

Remarks

While a TitleStorage can generally be kept open throughout runtime, a UserStorage should only be opened when the application is ready to read or write files. This allows the backend to properly batch file operations and flush them when the container has been closed; ensuring safe and optimal save I/O.

Exceptions