Philiprehberger.EmbeddedResource
0.1.2
There is a newer version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Philiprehberger.EmbeddedResource --version 0.1.2
NuGet\Install-Package Philiprehberger.EmbeddedResource -Version 0.1.2
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Philiprehberger.EmbeddedResource" Version="0.1.2" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Philiprehberger.EmbeddedResource" Version="0.1.2" />
<PackageReference Include="Philiprehberger.EmbeddedResource" />
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add Philiprehberger.EmbeddedResource --version 0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Philiprehberger.EmbeddedResource, 0.1.2"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package Philiprehberger.EmbeddedResource@0.1.2
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=Philiprehberger.EmbeddedResource&version=0.1.2
#tool nuget:?package=Philiprehberger.EmbeddedResource&version=0.1.2
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Philiprehberger.EmbeddedResource
Fluent access to embedded resources with string, stream, byte array, and JSON deserialization support.
Installation
dotnet add package Philiprehberger.EmbeddedResource
Usage
Reading Resources
using Philiprehberger.EmbeddedResource;
// Read as string
string html = EmbeddedResource.ReadString("Templates/welcome.html");
// Read as bytes
byte[] data = EmbeddedResource.ReadBytes("Assets/logo.png");
// Open as stream
using var stream = EmbeddedResource.OpenStream("Data/config.xml");
JSON Deserialization
using Philiprehberger.EmbeddedResource;
// Deserialize a JSON resource directly into a typed object
var settings = EmbeddedResource.ReadJson<AppSettings>("Config/defaults.json");
Console.WriteLine(settings.Theme); // "dark"
Console.WriteLine(settings.MaxRetries); // 3
Listing and Filtering Resources
using Philiprehberger.EmbeddedResource;
// List all embedded resource names in the calling assembly
string[] all = EmbeddedResource.List();
// Filter by pattern
string[] templates = EmbeddedResource.List("*.html");
// Read from a specific assembly
var assembly = typeof(MyPlugin).Assembly;
string text = EmbeddedResource.ReadString("plugin-config.json", assembly);
API
EmbeddedResource
| Method | Description |
|---|---|
ReadString(name, assembly?) |
Read an embedded resource as a string. |
ReadBytes(name, assembly?) |
Read an embedded resource as a byte array. |
OpenStream(name, assembly?) |
Open an embedded resource as a stream. |
ReadJson<T>(name, assembly?) |
Read and deserialize a JSON embedded resource. |
List(pattern?, assembly?) |
List available embedded resource names. |
Name resolution tries an exact match first, then falls back to suffix matching. For example, "Templates/welcome.html" will match "MyApp.Templates.welcome.html".
ResourceNotFoundException
Thrown when a resource cannot be found. Includes the list of available resource names in the exception message for easier debugging.
Development
dotnet build src/Philiprehberger.EmbeddedResource.csproj --configuration Release
License
MIT
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 was computed. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. net10.0-android was computed. net10.0-browser was computed. net10.0-ios was computed. net10.0-maccatalyst was computed. net10.0-macos was computed. net10.0-tvos was computed. net10.0-windows was computed. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net8.0
- No dependencies.
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.