Microsoft.Extensions.Primitives 9.0.0-preview.1.24080.9
About
Microsoft.Extensions.Primitives
contains isolated types that are used in many places within console or ASP.NET Core applications using framework extensions.
Key Features
- IChangeToken: An interface that represents a token that can notify when a change occurs. This can be used to trigger actions or invalidate caches when something changes. For example, the configuration and file providers libraries use this interface to reload settings or files when they are modified.
- StringValues: A struct that represents a single string or an array of strings. This can be used to efficiently store and manipulate multiple values that are logically a single value. For example, the HTTP headers and query strings libraries use this struct to handle multiple values for the same key.
- StringSegment: A struct that represents a substring of another string. This can be used to avoid allocating new strings when performing operations on parts of a string. For example, the configuration and logging libraries use this struct to parse and format strings.
How to Use
IChangeToken with configuration example
using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.Primitives;
using System;
class Program
{
static void Main(string[] args)
{
// Create a configuration builder
var configurationBuilder = new ConfigurationBuilder()
.SetBasePath(Environment.CurrentDirectory)
// appsettings.json expected to have the following contents:
// {
// "SomeKey": "SomeValue"
// }
.AddJsonFile("appsettings.json", optional: true, reloadOnChange: true);
// Build the configuration
IConfiguration configuration = configurationBuilder.Build();
// Create a change token for the configuration
IChangeToken changeToken = configuration.GetReloadToken();
// Attach a change callback
IDisposable changeTokenRegistration = changeToken.RegisterChangeCallback(state =>
{
Console.WriteLine("Configuration changed!");
IConfigurationRoot root = (IConfigurationRoot)state;
var someValue = root["SomeKey"]; // Access the updated configuration value
Console.WriteLine($"New value of SomeKey: {someValue}");
}, configuration);
// go and update the value of the key SomeKey in appsettings.json.
// The change callback will be invoked when the file is saved.
Console.WriteLine("Listening for configuration changes. Press any key to exit.");
Console.ReadKey();
// Clean up the change token registration when no longer needed
changeTokenRegistration.Dispose();
}
}
StringValues example
using System;
using Microsoft.Extensions.Primitives;
namespace StringValuesSample
{
class Program
{
static void Main(string[] args)
{
// Create a StringValues object from a single string or an array of strings
StringValues single = "Hello";
StringValues multiple = new string[] { "Hello", "World" };
// Use the implicit conversion to string or the ToString method to get the values
Console.WriteLine($"Single: {single}"); // Single: Hello
Console.WriteLine($"Multiple: {multiple}"); // Multiple: Hello,World
// Use the indexer, the Count property, and the IsNullOrEmpty method to access the values
Console.WriteLine($"Multiple[1]: {multiple[1]}"); // Multiple[1]: World
Console.WriteLine($"Single.Count: {single.Count}"); // Single.Count: 1
Console.WriteLine($"Multiple.IsNullOrEmpty: {StringValues.IsNullOrEmpty(multiple)}"); // Multiple.IsNullOrEmpty: False
// Use the Equals method or the == operator to compare two StringValues objects
Console.WriteLine($"single == \"Hello\": {single == "Hello"}"); // single == "Hello": True
Console.WriteLine($"multiple == \"Hello\": {multiple == "Hello"}"); // multiple == "Hello": False
}
}
}
Main Types
The main types provided by this library are:
IChangeToken
StringValues
StringSegment
Additional Documentation
Related Packages
Feedback & Contributing
Microsoft.Extensions.Primitives is released as open source under the MIT license. Bug reports and contributions are welcome at the GitHub repository.
Showing the top 20 packages that depend on Microsoft.Extensions.Primitives.
Packages | Downloads |
---|---|
Microsoft.AspNetCore.ResponseCaching.Abstractions
ASP.NET Core response caching middleware abstractions and feature interface definitions.
|
67 |
Microsoft.Extensions.Caching.Abstractions
Caching abstractions for in-memory cache and distributed cache.
Commonly used types:
Microsoft.Extensions.Caching.Distributed.IDistributedCache
Microsoft.Extensions.Caching.Memory.IMemoryCache
|
61 |
Microsoft.AspNetCore.ResponseCaching.Abstractions
ASP.NET Core response caching middleware abstractions and feature interface definitions.
|
60 |
Microsoft.AspNetCore.Mvc.TagHelpers
ASP.NET Core MVC default tag helpers. Contains tag helpers for anchor tags, HTML input elements, caching, scripts, links (for CSS), and more.
This package was built from the source code at https://github.com/aspnet/Mvc/tree/a6199bbfbab05583f987bae322fb04566841aaea
|
57 |
Microsoft.AspNetCore.WebUtilities
ASP.NET Core utilities, such as for working with forms, multipart messages, and query strings.
|
57 |
Microsoft.Net.Http.Headers
HTTP header parser implementations.
|
56 |
Microsoft.AspNetCore.ResponseCaching.Abstractions
ASP.NET Core response caching middleware abstractions and feature interface definitions.
|
55 |
Microsoft.Extensions.FileProviders.Composite
Composite file and directory providers for Microsoft.Extensions.FileProviders.
|
54 |
Microsoft.Extensions.FileProviders.Composite
Composite file and directory providers for Microsoft.Extensions.FileProviders.
When using NuGet 3.x this package requires at least version 3.4.
|
54 |
Microsoft.AspNetCore.Http.Features
ASP.NET Core HTTP feature interface definitions.
This package was built from the source code at https://github.com/dotnet/aspnetcore/tree/c0ae1d179dba6f3acd0e55be55718c97c9028698
|
51 |
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories.
Commonly used types:
Microsoft.Extensions.FileProviders.IDirectoryContents
Microsoft.Extensions.FileProviders.IFileInfo
Microsoft.Extensions.FileProviders.IFileProvider
|
51 |
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
|
51 |
Microsoft.AspNetCore.WebUtilities
ASP.NET Core utilities, such as for working with forms, multipart messages, and query strings.
|
50 |
Microsoft.AspNetCore.Mvc.TagHelpers
ASP.NET Core MVC default tag helpers. Contains tag helpers for anchor tags, HTML input elements, caching, scripts, links (for CSS), and more.
|
50 |
Microsoft.Extensions.Configuration
Implementation of key-value pair based configuration for Microsoft.Extensions.Configuration. Includes the memory configuration provider.
When using NuGet 3.x this package requires at least version 3.4.
|
48 |
Microsoft.AspNetCore.Mvc.TagHelpers
ASP.NET Core MVC default tag helpers. Contains tag helpers for anchor tags, HTML input elements, caching, scripts, links (for CSS), and more.
|
48 |
Microsoft.Net.Http.Headers
HTTP header parser implementations.
|
48 |
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
|
48 |
.NET Framework 4.6.2
- System.Memory (>= 4.5.5)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)
.NET 8.0
- No dependencies.
.NET 9.0
- No dependencies.
.NET Standard 2.0
- System.Memory (>= 4.5.5)
- System.Runtime.CompilerServices.Unsafe (>= 6.0.0)