Microsoft.Extensions.Primitives 9.0.0-preview.4.24266.19

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.AspNetCore.Http.Features
ASP.NET Core HTTP feature interface definitions. This package was built from the source code at https://github.com/aspnet/HttpAbstractions/tree/91db78cf926939821bc96e8e60616cf5dde0b489
33,416
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
14,970
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 When using NuGet 3.x this package requires at least version 3.4.
11,023
Microsoft.Extensions.Caching.Memory
In-memory cache implementation of Microsoft.Extensions.Caching.Memory.IMemoryCache.
15,014
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.
12,013
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
21,139
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
21,309
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
21,429
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
15,276
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 This package was built from the source code at https://github.com/aspnet/Extensions/tree/9bc79b2f25a3724376d7af19617c33749a30ea3a
34,363
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 When using NuGet 3.x this package requires at least version 3.4.
13,255
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories. Commonly used types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider
21,367
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories. Commonly used types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider
23,492
Microsoft.Extensions.FileProviders.Abstractions
Abstractions of files and directories. Commonly used types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider This package was built from the source code at https://github.com/aspnet/Extensions/tree/9bc79b2f25a3724376d7af19617c33749a30ea3a
34,342
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
21,417
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
23,916
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection.
25,017
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection. This package was built from the source code at https://github.com/aspnet/Extensions/tree/9bc79b2f25a3724376d7af19617c33749a30ea3a
24,725
Microsoft.Extensions.Options
Provides a strongly typed way of specifying and accessing settings using dependency injection. When using NuGet 3.x this package requires at least version 3.4.
23,909
Microsoft.Net.Http.Headers
HTTP header parser implementations. This package was built from the source code at https://github.com/aspnet/HttpAbstractions/tree/91db78cf926939821bc96e8e60616cf5dde0b489
24,189

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-preview.4.24266.19 2 05/22/2024
9.0.0-preview.3.24172.9 4 04/18/2024
9.0.0-preview.2.24128.5 5 03/15/2024
9.0.0-preview.1.24080.9 4 03/11/2024
8.0.0 7 11/16/2023
8.0.0-rc.2.23479.6 6 10/18/2023
8.0.0-rc.1.23419.4 6 09/14/2023
8.0.0-preview.7.23375.6 15 09/16/2023
8.0.0-preview.6.23329.7 5 09/13/2023
8.0.0-preview.5.23280.8 9 06/14/2023
8.0.0-preview.4.23259.5 8 06/22/2023
8.0.0-preview.3.23174.8 8 06/22/2023
8.0.0-preview.2.23128.3 7 04/04/2023
8.0.0-preview.1.23110.8 9 04/04/2023
7.0.0 8,381 11/15/2022
7.0.0-rc.2.22472.3 5 09/11/2023
7.0.0-rc.1.22426.10 9 09/21/2022
7.0.0-preview.7.22375.6 9 09/23/2022
7.0.0-preview.6.22324.4 7 09/21/2022
7.0.0-preview.5.22301.12 5 09/11/2023
7.0.0-preview.4.22229.4 8 09/23/2022
7.0.0-preview.3.22175.4 7 09/26/2022
7.0.0-preview.2.22152.2 9 09/26/2022
7.0.0-preview.1.22076.8 6 09/24/2022
6.0.2-mauipre.1.22102.15 7 09/07/2022
6.0.2-mauipre.1.22054.8 10 09/21/2022
6.0.0 24,965 06/27/2022
6.0.0-rc.2.21480.5 8 09/22/2022
6.0.0-rc.1.21451.13 7 09/23/2022
6.0.0-preview.7.21377.19 10 09/23/2022
6.0.0-preview.6.21352.12 9 09/11/2023
6.0.0-preview.5.21301.5 8 09/22/2022
6.0.0-preview.4.21253.7 8 09/21/2022
6.0.0-preview.3.21201.4 9 09/22/2022
6.0.0-preview.2.21154.6 6 09/11/2023
6.0.0-preview.1.21102.12 9 01/07/2023
5.0.1 8 02/17/2023
5.0.0 23,838 06/27/2022
5.0.0-rc.2.20475.5 8 09/14/2023
5.0.0-rc.1.20451.14 7 09/24/2022
5.0.0-preview.8.20407.11 6 09/21/2022
5.0.0-preview.7.20364.11 10 09/24/2022
5.0.0-preview.6.20305.6 10 09/22/2022
5.0.0-preview.5.20278.1 10 09/23/2022
5.0.0-preview.4.20251.6 10 09/21/2022
5.0.0-preview.3.20215.2 12 09/23/2022
5.0.0-preview.2.20160.3 9 09/21/2022
5.0.0-preview.1.20120.4 8 09/23/2022
3.1.32 8 01/14/2023
3.1.31 8 12/12/2022
3.1.30 11 12/07/2022
3.1.29 14 09/22/2022
3.1.28 11 09/24/2022
3.1.27 9 09/21/2022
3.1.26 10 09/22/2022
3.1.25 9 09/24/2022
3.1.24 8 12/18/2022
3.1.23 12 06/27/2022
3.1.22 10 09/25/2022
3.1.21 10 09/22/2022
3.1.20 14 09/24/2022
3.1.19 12 09/22/2022
3.1.18 7 09/22/2022
3.1.17 13 09/11/2022
3.1.16 12 09/21/2022
3.1.15 14 07/09/2022
3.1.14 17 08/07/2022
3.1.13 11 09/23/2022
3.1.12 7 09/25/2022
3.1.11 10 06/27/2022
3.1.10 10 09/23/2022
3.1.9 10 07/12/2022
3.1.8 24,038 06/27/2022
3.1.7 12 09/21/2022
3.1.6 10 09/24/2022
3.1.5 9,250 06/27/2022
3.1.4 8,756 07/03/2022
3.1.3 9,215 06/27/2022
3.1.2 9 09/24/2022
3.1.1 10 09/21/2022
3.1.0 2,085 06/27/2022
3.1.0-preview3.19553.2 9 09/23/2022
3.1.0-preview2.19525.4 12 08/17/2022
3.1.0-preview1.19506.1 8 09/23/2022
3.0.3 8 09/26/2022
3.0.2 12 09/21/2022
3.0.1 12 09/22/2022
3.0.0 9,180 06/27/2022
3.0.0-rc1.19456.10 8 09/21/2022
3.0.0-preview9.19423.4 11 09/26/2022
3.0.0-preview8.19405.4 9 06/28/2022
3.0.0-preview7.19362.4 9 07/07/2022
3.0.0-preview6.19304.6 9 09/22/2022
3.0.0-preview5.19227.9 11 09/21/2022
3.0.0-preview4.19216.2 11 08/04/2022
3.0.0-preview3.19153.1 7 09/25/2023
3.0.0-preview.19074.2 8 09/22/2022
3.0.0-preview.18572.1 10 09/22/2022
2.2.0 35,699 06/27/2022
2.2.0-preview3-35497 8 09/22/2022
2.2.0-preview2-35157 9 09/22/2022
2.2.0-preview1-35029 11 09/23/2022
2.1.6 9 12/06/2022
2.1.1 21,431 06/27/2022
2.1.0 1,735 06/27/2022
2.1.0-rc1-final 6 09/23/2022
2.1.0-preview2-final 11 09/23/2022
2.1.0-preview1-final 7 09/26/2022
2.0.0 23,911 06/27/2022
2.0.0-preview2-final 10 04/06/2023
2.0.0-preview1-final 13 09/22/2022
1.1.1 10 09/24/2022
1.1.0 3,497 06/27/2022
1.1.0-preview1-final 10 09/22/2022
1.0.1 8 09/21/2022
1.0.0 7 06/27/2022
1.0.0-rc2-final 12 09/22/2022
1.0.0-rc1-final 7 09/22/2022