Microsoft.Extensions.Primitives 9.0.0

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

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.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
94
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
96
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
99
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
120
Microsoft.Extensions.Configuration
Implementation of key-value pair based configuration for Microsoft.Extensions.Configuration. Includes the memory configuration provider.
99
Microsoft.Extensions.Configuration.Abstractions
Abstractions of key-value pair based configuration. Commonly used types: Microsoft.Extensions.Configuration.IConfiguration Microsoft.Extensions.Configuration.IConfigurationBuilder Microsoft.Extensions.Configuration.IConfigurationProvider Microsoft.Extensions.Configuration.IConfigurationRoot Microsoft.Extensions.Configuration.IConfigurationSection
109
Microsoft.Extensions.Configuration.Abstractions
Abstractions of key-value pair based configuration. Commonly used types: Microsoft.Extensions.Configuration.IConfiguration Microsoft.Extensions.Configuration.IConfigurationBuilder Microsoft.Extensions.Configuration.IConfigurationProvider Microsoft.Extensions.Configuration.IConfigurationRoot Microsoft.Extensions.Configuration.IConfigurationSection
230
Microsoft.Extensions.Configuration.Abstractions
Abstractions of key-value pair based configuration. Commonly used types: Microsoft.Extensions.Configuration.IConfiguration Microsoft.Extensions.Configuration.IConfigurationBuilder Microsoft.Extensions.Configuration.IConfigurationProvider Microsoft.Extensions.Configuration.IConfigurationRoot Microsoft.Extensions.Configuration.IConfigurationSection
239
Microsoft.Extensions.Configuration.Abstractions
Abstractions of key-value pair based configuration. Commonly Used Types: Microsoft.Extensions.Configuration.IConfiguration Microsoft.Extensions.Configuration.IConfigurationBuilder Microsoft.Extensions.Configuration.IConfigurationProvider Microsoft.Extensions.Configuration.IConfigurationRoot Microsoft.Extensions.Configuration.IConfigurationSection
110
Microsoft.Extensions.Configuration.Abstractions
Abstractions of key-value pair based configuration. Commonly Used Types: Microsoft.Extensions.Configuration.IConfiguration Microsoft.Extensions.Configuration.IConfigurationBuilder Microsoft.Extensions.Configuration.IConfigurationProvider Microsoft.Extensions.Configuration.IConfigurationRoot Microsoft.Extensions.Configuration.IConfigurationSection
144
Microsoft.Extensions.Configuration.Abstractions
Provides abstractions of key-value pair based configuration. Interfaces defined in this package are implemented by classes in Microsoft.Extensions.Configuration and other configuration packages.
170
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories. Commonly used types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider
134
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories. Commonly used types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider
236
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories. Commonly Used Types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider
124
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories. Commonly Used Types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider
175
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
124
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
128
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
184
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
205
Microsoft.Extensions.Options.ConfigurationExtensions
Provides additional configuration specific functionality related to Options.
106

https://go.microsoft.com/fwlink/?LinkID=799421

.NET Framework 4.6.2

.NET 8.0

  • No dependencies.

.NET 9.0

  • No dependencies.

.NET Standard 2.0

Version Downloads Last updated
9.0.0 6 11/14/2024
9.0.0-rc.2.24473.5 10 10/17/2024
9.0.0-rc.1.24431.7 5 10/28/2024
9.0.0-preview.7.24405.7 19 08/18/2024
9.0.0-preview.6.24327.7 35 07/22/2024
9.0.0-preview.5.24306.7 30 06/24/2024
9.0.0-preview.4.24266.19 26 07/22/2024
9.0.0-preview.3.24172.9 34 07/22/2024
9.0.0-preview.2.24128.5 26 07/22/2024
9.0.0-preview.1.24080.9 40 07/22/2024
8.0.0 199 02/04/2024
8.0.0-rc.2.23479.6 25 07/22/2024
8.0.0-rc.1.23419.4 31 07/22/2024
8.0.0-preview.7.23375.6 26 07/22/2024
8.0.0-preview.6.23329.7 35 07/22/2024
8.0.0-preview.5.23280.8 30 07/22/2024
8.0.0-preview.4.23259.5 31 07/22/2024
8.0.0-preview.3.23174.8 34 07/22/2024
8.0.0-preview.2.23128.3 33 07/22/2024
8.0.0-preview.1.23110.8 39 07/22/2024
7.0.0 178 02/04/2024
7.0.0-rc.2.22472.3 34 07/22/2024
7.0.0-rc.1.22426.10 37 07/22/2024
7.0.0-preview.7.22375.6 28 07/22/2024
7.0.0-preview.6.22324.4 32 07/22/2024
7.0.0-preview.5.22301.12 32 07/22/2024
7.0.0-preview.4.22229.4 27 07/22/2024
7.0.0-preview.3.22175.4 30 07/22/2024
7.0.0-preview.2.22152.2 39 07/22/2024
7.0.0-preview.1.22076.8 29 07/22/2024
6.0.1 8 11/14/2024
6.0.0 180 02/04/2024
6.0.0-rc.2.21480.5 36 07/22/2024
6.0.0-rc.1.21451.13 39 07/22/2024
6.0.0-preview.7.21377.19 35 07/22/2024
6.0.0-preview.6.21352.12 35 07/22/2024
6.0.0-preview.5.21301.5 40 07/22/2024
6.0.0-preview.4.21253.7 27 07/22/2024
6.0.0-preview.3.21201.4 35 07/22/2024
6.0.0-preview.2.21154.6 41 07/22/2024
6.0.0-preview.1.21102.12 42 07/22/2024
5.0.1 26 07/22/2024
5.0.0 132 02/04/2024
5.0.0-rc.2.20475.5 33 07/22/2024
5.0.0-rc.1.20451.14 29 07/22/2024
5.0.0-preview.8.20407.11 35 07/22/2024
5.0.0-preview.7.20364.11 23 07/22/2024
5.0.0-preview.6.20305.6 41 07/22/2024
5.0.0-preview.5.20278.1 35 07/22/2024
5.0.0-preview.4.20251.6 27 07/22/2024
5.0.0-preview.3.20215.2 36 07/22/2024
5.0.0-preview.2.20160.3 30 07/22/2024
5.0.0-preview.1.20120.4 35 07/22/2024
3.1.32 38 07/22/2024
3.1.31 29 07/22/2024
3.1.30 29 07/22/2024
3.1.29 37 07/22/2024
3.1.28 32 07/22/2024
3.1.27 37 07/22/2024
3.1.26 31 07/22/2024
3.1.25 35 07/22/2024
3.1.24 31 07/22/2024
3.1.23 34 07/22/2024
3.1.22 29 07/22/2024
3.1.21 34 07/22/2024
3.1.20 36 07/22/2024
3.1.19 26 07/22/2024
3.1.18 266 02/04/2024
3.1.17 36 07/22/2024
3.1.16 16 07/22/2024
3.1.15 27 07/22/2024
3.1.14 31 07/22/2024
3.1.13 25 07/22/2024
3.1.12 30 07/22/2024
3.1.11 33 07/22/2024
3.1.10 34 07/22/2024
3.1.9 30 07/22/2024
3.1.8 95 02/04/2024
3.1.7 27 07/22/2024
3.1.6 32 07/22/2024
3.1.5 25 07/22/2024
3.1.4 31 07/22/2024
3.1.3 32 07/22/2024
3.1.2 43 07/22/2024
3.1.1 40 07/22/2024
3.1.0 37 07/22/2024
3.1.0-preview3.19553.2 42 07/22/2024
3.1.0-preview2.19525.4 34 07/22/2024
3.1.0-preview1.19506.1 29 07/22/2024
3.0.3 35 07/22/2024
3.0.2 48 07/22/2024
3.0.1 33 07/22/2024
3.0.0 27 07/22/2024
3.0.0-rc1.19456.10 25 07/22/2024
3.0.0-preview9.19423.4 35 07/22/2024
3.0.0-preview8.19405.4 34 07/22/2024
3.0.0-preview7.19362.4 30 07/22/2024
3.0.0-preview6.19304.6 34 07/22/2024
3.0.0-preview5.19227.9 29 07/22/2024
3.0.0-preview4.19216.2 31 07/22/2024
3.0.0-preview3.19153.1 31 07/22/2024
3.0.0-preview.19074.2 36 07/22/2024
3.0.0-preview.18572.1 29 07/22/2024
2.2.0 82 02/05/2024
2.2.0-preview3-35497 28 07/22/2024
2.2.0-preview2-35157 36 07/22/2024
2.2.0-preview1-35029 29 07/22/2024
2.1.6 36 07/22/2024
2.1.1 39 07/22/2024
2.1.0 26 07/22/2024
2.1.0-rc1-final 36 07/22/2024
2.1.0-preview2-final 29 07/22/2024
2.1.0-preview1-final 29 07/22/2024
2.0.0 218 02/04/2024
2.0.0-preview2-final 29 07/22/2024
2.0.0-preview1-final 29 07/22/2024
1.1.1 29 07/22/2024
1.1.0 36 07/22/2024
1.1.0-preview1-final 30 07/22/2024
1.0.1 30 07/22/2024
1.0.0 38 07/22/2024
1.0.0-rc2-final 36 07/22/2024
1.0.0-rc1-final 33 07/22/2024