EmbeddedResourceWriter

Definition

Assembly: CloudNimble.EasyAF.Tools.dll Namespace: CloudNimble.EasyAF.Tools.Scaffolding Inheritance: System.Object

Syntax

CloudNimble.EasyAF.Tools.Scaffolding.EmbeddedResourceWriter

Summary

Renders text files embedded in an assembly, replacing {{Token}} placeholders, and writes them to disk.

Remarks

Resources are expected to use path-preserving logical names (for example Resources/Api/Program.cs) so that folder names containing dots are not confused with nested folders. Tokens are replaced in a single pass, so a token value that itself looks like a token is written literally. A placeholder with no matching token is an error rather than something to ship. Line endings are normalized to NewLine.

Constructors

.ctor

Initializes a new instance of the EmbeddedResourceWriter class that reads the EasyAF Tools assembly’s Resources/ folder.

Syntax

public EmbeddedResourceWriter(System.Collections.Generic.IReadOnlyDictionary<string, string> tokens)

Parameters

Name	Type	Description
`tokens`	`System.Collections.Generic.IReadOnlyDictionary<string, string>`	The tokens that replace `{{Name}}` placeholders.

.ctor

Initializes a new instance of the EmbeddedResourceWriter class.

Syntax

public EmbeddedResourceWriter(System.Collections.Generic.IReadOnlyDictionary<string, string> tokens, System.Reflection.Assembly assembly, string rootFolder)

Parameters

Name	Type	Description
`tokens`	`System.Collections.Generic.IReadOnlyDictionary<string, string>`	The tokens that replace `{{Name}}` placeholders.
`assembly`	`System.Reflection.Assembly`	The assembly the resources are embedded in.
`rootFolder`	`string`	The logical folder resource names are relative to.

.ctor Inherited

Inherited from object

Syntax

public Object()

Properties

Assembly

Gets the assembly the resources are read from.

Syntax

public System.Reflection.Assembly Assembly { get; }

Property Value

Type: System.Reflection.Assembly

ResourceNames

Gets the names of the available resources, relative to EmbeddedResourceWriter.RootFolder, with forward slashes, sorted.

Syntax

public System.Collections.Generic.IReadOnlyList<string> ResourceNames { get; }

Property Value

Type: System.Collections.Generic.IReadOnlyList<string>

RootFolder

Gets the logical folder that resource names are relative to (for example Resources).

Syntax

public string RootFolder { get; }

Property Value

Type: string

Tokens

Gets the tokens that replace {{Name}} placeholders.

Syntax

public System.Collections.Generic.IReadOnlyDictionary<string, string> Tokens { get; }

Property Value

Type: System.Collections.Generic.IReadOnlyDictionary<string, string>

Methods

Equals Inherited Virtual

Inherited from object

Syntax

public virtual bool Equals(object obj)

Parameters

Name	Type	Description
`obj`	`object?`	-

Returns

Type: bool

Equals Inherited

Inherited from object

Syntax

public static bool Equals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

GetHashCode Inherited Virtual

Inherited from object

Syntax

public virtual int GetHashCode()

Returns

Type: int

GetType Inherited

Inherited from object

Syntax

public System.Type GetType()

Returns

Type: System.Type

MemberwiseClone Inherited

Inherited from object

Syntax

protected internal object MemberwiseClone()

Returns

Type: object

ReferenceEquals Inherited

Inherited from object

Syntax

public static bool ReferenceEquals(object objA, object objB)

Parameters

Name	Type	Description
`objA`	`object?`	-
`objB`	`object?`	-

Returns

Type: bool

Render

Renders a resource with its tokens replaced.

Syntax

public string Render(string resourceName)

Parameters

Name	Type	Description
`resourceName`	`string`	The resource name relative to EmbeddedResourceWriter.RootFolder, for example `Api/Program.cs`.

Returns

Type: string The rendered text.

Exceptions

Exception	Description
`FileNotFoundException`	Thrown when no resource with that name exists.
`InvalidOperationException`	Thrown when the resource contains a placeholder with no matching token.

ToString Inherited Virtual

Inherited from object

Syntax

public virtual string ToString()

Returns

Type: string?

WriteAsync

Renders a resource and writes it to disk as UTF-8 without a byte order mark, creating parent directories and replacing any existing file.

Syntax

public System.Threading.Tasks.Task<string> WriteAsync(string resourceName, string destinationPath, System.Threading.CancellationToken cancellationToken = null)

Parameters

Name	Type	Description
`resourceName`	`string`	The resource name relative to EmbeddedResourceWriter.RootFolder.
`destinationPath`	`string`	The file to write.
`cancellationToken`	`System.Threading.CancellationToken`	A token to cancel the operation.

Returns

Type: System.Threading.Tasks.Task<string> The full path of the written file.

Exceptions

Exception	Description
`FileNotFoundException`	Thrown when no resource with that name exists.
`InvalidOperationException`	Thrown when the resource contains a placeholder with no matching token. Nothing is written.

​Definition

​Syntax

​Summary

​Remarks

​Constructors

​ .ctor

​Syntax

​Parameters

​ .ctor

​Syntax

​Parameters

​ .ctor Inherited

​Syntax

​Properties

​ Assembly

​Syntax

​Property Value

​ ResourceNames

​Syntax

​Property Value

​ RootFolder

​Syntax

​Property Value

​ Tokens

​Syntax

​Property Value

​Methods

​ Equals Inherited Virtual

​Syntax

​Parameters

​Returns

​ Equals Inherited

​Syntax

​Parameters

​Returns

​ GetHashCode Inherited Virtual

​Syntax

​Returns

​ GetType Inherited

​Syntax

​Returns

​ MemberwiseClone Inherited

​Syntax

​Returns

​ ReferenceEquals Inherited

​Syntax

​Parameters

​Returns

​ Render

​Syntax

​Parameters

​Returns

​Exceptions

​ ToString Inherited Virtual

​Syntax

​Returns

​ WriteAsync

​Syntax

​Parameters

​Returns

​Exceptions

Definition

Syntax

Summary

Remarks

Constructors

.ctor

Syntax

Parameters

.ctor

Syntax

Parameters

.ctor Inherited

Syntax

Properties

Assembly

Syntax

Property Value

ResourceNames

Syntax

Property Value

RootFolder

Syntax

Property Value

Tokens

Syntax

Property Value

Methods

Equals Inherited Virtual

Syntax

Parameters

Returns

Equals Inherited

Syntax

Parameters

Returns

GetHashCode Inherited Virtual

Syntax

Returns

GetType Inherited

Syntax

Returns

MemberwiseClone Inherited

Syntax

Returns

ReferenceEquals Inherited

Syntax

Parameters

Returns

Render

Syntax

Parameters

Returns

Exceptions

ToString Inherited Virtual

Syntax

Returns

WriteAsync

Syntax

Parameters

Returns

Exceptions