Class ProjectFileWriter

Namespace

RDCore.SDK.Workspace

Assembly

RDCore.SDK.dll

Writes a workspace's .rdproj ProjectFile to disk — the write counterpart of IProjectFileLoader. Used to scaffold a new workspace and (eventually) to persist edits a client makes to the project structure.

public sealed class ProjectFileWriter : IProjectFileWriter

Inheritance

object

ProjectFileWriter

Implements

IProjectFileWriter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ProjectFileWriter(IFileSystem)

Writes a workspace's .rdproj ProjectFile to disk — the write counterpart of IProjectFileLoader. Used to scaffold a new workspace and (eventually) to persist edits a client makes to the project structure.

public ProjectFileWriter(IFileSystem fileSystem)

Parameters

fileSystem IFileSystem

Methods

SaveAsync(ProjectFile, CancellationToken)

Serializes project to <project.Uri>/.rdproj, overwriting any existing file. The parent directory must exist. IsDirty is not consulted — the caller decides whether a write is warranted.

public Task SaveAsync(ProjectFile project, CancellationToken token = default)

Parameters

project ProjectFile

The project to write; its Uri is the workspace root.

token CancellationToken

A token that cancels the write.

Returns

Task

Exceptions

IOException

The file could not be written.