Microsoft.Extensions.Primitives 9.0.0-preview.1.24080.9

The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org. Prefix Reserved
This is a prerelease version of Microsoft.Extensions.Primitives.
There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package Microsoft.Extensions.Primitives --version 9.0.0-preview.1.24080.9
NuGet\Install-Package Microsoft.Extensions.Primitives -Version 9.0.0-preview.1.24080.9
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="Microsoft.Extensions.Primitives" Version="9.0.0-preview.1.24080.9" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Microsoft.Extensions.Primitives --version 9.0.0-preview.1.24080.9
#r "nuget: Microsoft.Extensions.Primitives, 9.0.0-preview.1.24080.9"
#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.
// Install Microsoft.Extensions.Primitives as a Cake Addin
#addin nuget:?package=Microsoft.Extensions.Primitives&version=9.0.0-preview.1.24080.9&prerelease

// Install Microsoft.Extensions.Primitives as a Cake Tool
#tool nuget:?package=Microsoft.Extensions.Primitives&version=9.0.0-preview.1.24080.9&prerelease

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.

Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  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 is compatible. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (492)

Showing the top 5 NuGet packages that depend on Microsoft.Extensions.Primitives:

Package Downloads
Microsoft.Extensions.Options The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Provides a strongly typed way of specifying and accessing settings using dependency injection.

Microsoft.Extensions.Configuration.Abstractions The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

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.

Microsoft.Extensions.Configuration The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Implementation of key-value pair based configuration for Microsoft.Extensions.Configuration. Includes the memory configuration provider.

Microsoft.Extensions.FileProviders.Abstractions The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

Abstractions of files and directories. Commonly Used Types: Microsoft.Extensions.FileProviders.IDirectoryContents Microsoft.Extensions.FileProviders.IFileInfo Microsoft.Extensions.FileProviders.IFileProvider

Microsoft.Extensions.FileProviders.Physical The ID prefix of this package has been reserved for one of the owners of this package by NuGet.org.

File provider for physical files for Microsoft.Extensions.FileProviders.

GitHub repositories (169)

Showing the top 5 popular GitHub repositories that depend on Microsoft.Extensions.Primitives:

Repository Stars
dotnet/AspNetCore.Docs
Documentation for ASP.NET Core
JeffreySu/WeiXinMPSDK
微信全平台 SDK Senparc.Weixin for C#,支持 .NET Framework 及 .NET Core、.NET 6.0、.NET 8.0。已支持微信公众号、小程序、小游戏、微信支付、企业微信/企业号、开放平台、JSSDK、微信周边等全平台。 WeChat SDK for C#.
microsoft/ailab
Experience, Learn and Code the latest breakthrough innovations with Microsoft AI
aspnet/Mvc
[Archived] ASP.NET Core MVC is a model view controller framework for building dynamic web sites with clean separation of concerns, including the merged MVC, Web API, and Web Pages w/ Razor. Project moved to https://github.com/aspnet/AspNetCore
ServiceStack/ServiceStack
Thoughtfully architected, obscenely fast, thoroughly enjoyable web services for all
Version Downloads Last updated
9.0.0-preview.3.24172.9 5,898 4/11/2024
9.0.0-preview.2.24128.5 36,142 3/12/2024
9.0.0-preview.1.24080.9 92,338 2/13/2024
8.0.0 40,637,716 11/14/2023
8.0.0-rc.2.23479.6 1,233,857 10/10/2023
8.0.0-rc.1.23419.4 832,951 9/12/2023
8.0.0-preview.7.23375.6 421,673 8/8/2023
8.0.0-preview.6.23329.7 358,520 7/11/2023
8.0.0-preview.5.23280.8 272,246 6/13/2023
8.0.0-preview.4.23259.5 401,806 5/16/2023
8.0.0-preview.3.23174.8 425,976 4/11/2023
8.0.0-preview.2.23128.3 417,509 3/14/2023
8.0.0-preview.1.23110.8 334,137 2/21/2023
7.0.0 196,840,328 11/7/2022
7.0.0-rc.2.22472.3 643,019 10/11/2022
7.0.0-rc.1.22426.10 556,531 9/14/2022
7.0.0-preview.7.22375.6 414,998 8/9/2022
7.0.0-preview.6.22324.4 316,813 7/12/2022
7.0.0-preview.5.22301.12 229,171 6/14/2022
7.0.0-preview.4.22229.4 482,953 5/10/2022
7.0.0-preview.3.22175.4 210,937 4/13/2022
7.0.0-preview.2.22152.2 340,295 3/14/2022
7.0.0-preview.1.22076.8 232,314 2/17/2022
6.0.2-mauipre.1.22102.15 233,504 2/15/2022
6.0.2-mauipre.1.22054.8 475,157 1/19/2022
6.0.0 467,337,809 11/8/2021
6.0.0-rc.2.21480.5 1,845,126 10/12/2021
6.0.0-rc.1.21451.13 697,347 9/14/2021
6.0.0-preview.7.21377.19 840,138 8/10/2021
6.0.0-preview.6.21352.12 423,188 7/14/2021
6.0.0-preview.5.21301.5 391,387 6/15/2021
6.0.0-preview.4.21253.7 1,203,447 5/24/2021
6.0.0-preview.3.21201.4 781,240 4/8/2021
6.0.0-preview.2.21154.6 280,170 3/11/2021
6.0.0-preview.1.21102.12 720,521 2/12/2021
5.0.1 40,331,992 4/6/2021
5.0.0 461,573,918 11/9/2020
5.0.0-rc.2.20475.5 1,102,780 10/13/2020
5.0.0-rc.1.20451.14 950,886 9/14/2020
5.0.0-preview.8.20407.11 637,235 8/25/2020
5.0.0-preview.7.20364.11 531,452 7/21/2020
5.0.0-preview.6.20305.6 254,929 6/25/2020
5.0.0-preview.5.20278.1 300,094 6/10/2020
5.0.0-preview.4.20251.6 433,481 5/18/2020
5.0.0-preview.3.20215.2 327,029 4/23/2020
5.0.0-preview.2.20160.3 436,510 4/2/2020
5.0.0-preview.1.20120.4 231,978 3/16/2020
3.1.32 12,491,597 12/13/2022
3.1.31 2,391,554 11/8/2022
3.1.30 2,773,592 10/11/2022
3.1.29 2,114,444 9/13/2022
3.1.28 5,415,101 8/9/2022
3.1.27 2,126,063 7/12/2022
3.1.26 1,903,505 6/14/2022
3.1.25 3,516,945 5/10/2022
3.1.24 10,126,984 4/11/2022
3.1.23 5,297,196 3/8/2022
3.1.22 19,868,288 12/14/2021
3.1.21 11,275,094 11/7/2021
3.1.20 5,805,597 10/11/2021
3.1.19 6,087,633 9/14/2021
3.1.18 54,568,700 8/10/2021
3.1.17 8,176,592 7/13/2021
3.1.16 13,825,792 6/8/2021
3.1.15 9,969,536 5/11/2021
3.1.14 20,236,711 4/6/2021
3.1.13 17,571,513 3/9/2021
3.1.12 13,539,478 2/9/2021
3.1.11 21,472,238 1/12/2021
3.1.10 33,349,489 11/9/2020
3.1.9 76,341,118 10/13/2020
3.1.8 219,598,853 9/8/2020
3.1.7 43,654,546 8/11/2020
3.1.6 49,205,455 7/14/2020
3.1.5 52,931,765 6/9/2020
3.1.4 62,179,975 5/12/2020
3.1.3 101,739,628 3/24/2020
3.1.2 83,266,893 2/18/2020
3.1.1 49,019,475 1/14/2020
3.1.0 220,015,921 12/3/2019
3.1.0-preview3.19553.2 1,573,412 11/13/2019
3.1.0-preview2.19525.4 230,509 11/1/2019
3.1.0-preview1.19506.1 1,253,409 10/15/2019
3.0.3 54,929,205 2/18/2020
3.0.2 1,236,261 1/14/2020
3.0.1 8,219,219 11/18/2019
3.0.0 185,712,129 9/23/2019
3.0.0-rc1.19456.10 186,757 9/16/2019
3.0.0-preview9.19423.4 1,732,252 9/4/2019
3.0.0-preview8.19405.4 628,305 8/13/2019
3.0.0-preview7.19362.4 368,019 7/23/2019
3.0.0-preview6.19304.6 867,088 6/12/2019
3.0.0-preview5.19227.9 863,376 5/6/2019
3.0.0-preview4.19216.2 99,315 4/18/2019
3.0.0-preview3.19153.1 444,919 3/6/2019
3.0.0-preview.19074.2 256,087 1/29/2019
3.0.0-preview.18572.1 198,788 12/4/2018
2.2.0 616,447,159 12/3/2018
2.2.0-preview3-35497 791,236 10/17/2018
2.2.0-preview2-35157 655,494 9/12/2018
2.2.0-preview1-35029 363,309 8/22/2018
2.1.6 7,469,025 11/13/2018
2.1.1 373,772,161 6/18/2018
2.1.0 461,581,402 5/29/2018
2.1.0-rc1-final 721,994 5/6/2018
2.1.0-preview2-final 1,057,381 4/10/2018
2.1.0-preview1-final 2,084,141 2/26/2018
2.0.0 568,869,079 8/11/2017
2.0.0-preview2-final 744,988 6/28/2017
2.0.0-preview1-final 789,481 5/10/2017
1.1.1 71,369,127 5/9/2017
1.1.0 49,886,244 11/16/2016
1.1.0-preview1-final 281,830 10/24/2016
1.0.1 139,011,001 12/12/2016
1.0.0 241,377,183 6/27/2016
1.0.0-rc2-final 2,293,012 5/16/2016
1.0.0-rc1-final 1,019,115 11/18/2015